import Item from 'WTF-Adventure/WTF-Adventure/client/entity/objects/item.js'

public class | source

Item

Extends:

Entity → Item

This os an object type of Entity

Constructor Summary

Public Constructor
public	constructor(id: Number, kind: String, name: String, count: Number, ability: Ability, abilityLevel: Number) Default constructor

Member Summary

Public Members
public	ability: Ability Ability
public	abilityLevel: Number Ability level
public	count: Number How many
public	dropped: Boolean If this item was dropped
public	shadow: Boolean Whether or not it has a shadow
public	stackable: Boolean If this item is stacked
public	type: String Type of entity

Method Summary

Public Methods
public	hasShadow(): Boolean Check if this has a shadow or not
public	idle() Set the idle animation

Inherited Summary

From class Entity
public	angle: Number Angle of the entity
public	angled: Boolean [angled description]
public	animations: Animation Animations for the sprite
public	blinking: Function Timeout function for blinking
public	countdownTime: Number Count down time
public	counter: Number Current counter
public	critical: Boolean Critical health
public	currentAnimation: String Current animation the sprite should be playing
public	dirty: Boolean Set if the entity is dirty
public	dirtyCallback: Function Callback for when the entity is dirty
public	fading: Boolean Whether or not this is fading
public	fadingTime: Number Fading time
public	gridX: Number Grid X position
public	gridY: Number Grid Y position
public	handler: EntityHandler Handler for the entity
public	hasCounter: Boolean Has a counter
public	hurtSprite: String Hurt sprite name
public	id: Number Entity id
public	label: String Label for the entity
public	name: String Name of the entity
public	nonPathable: Boolean Non pathable
public	normalSprite: String Normal sprite name
public	path: Boolean Path
public	readyCallback: Function CAllback function when the entity is ready
public	renderingData: Object Rendering data
public	shadow: Boolean Has a shadow
public	shadowOffsetY: Number Offset for the shadow on the Y axis
public	sprite: Sprite Sprite
public	spriteFlipX: Boolean Whether or not to flip the sprite on the X axis
public	spriteFlipY: Boolean Whether or not to flip the sprite on the Y axis
public	spriteLoaded: Boolean Whether or not the sprite has been loaded
public	stunned: Boolean Stunned status
public	terror: Boolean Terror status
public	visible: Boolean Wehther or not this entity is visible
public	x: Number X coordinate
public	y: Number Y coordinate
public	blink(speed: Number) Tell this entity to start blinking
public	fadeIn(time: Number) Tell this to fade in given the duration
public	getAnimationByName(name: String): Animation \| null Look for an animtions list for this specific animation given it's name
public	getCoordDistance(toX: Number, toY: Number): Number Get the distance from this entity to the given x,y coordinates
public	getDistance(entity: Entity): Number Get the distance from this entity to another entity
public	getSprite(): String Returns the name of the sprite
public	hasPath(): Object Check if this entity currently has a path
public	hasShadow(): Object Check whether or not this entity has a shadow
public	hasWeapon(): Item \| Projectile Returns the instance of the weapon this entity has
public	inAttackRadius(entity: Entity): Boolean Figure out if this entity is within the attack radius of the given entity
public	inExtraAttackRadius(entity: Entity): Boolean Figure out if this entity is within the extended attack radius of the given entity
public	isPositionAdjacent(x: Number, y: Number, ignoreDiagonals: Boolean): Boolean Checks to see if the x,y coordinate is adjacent to the entity's current position
public	isVisible(): Boolean Check whether or not this entity is visible
public	loadDirty() This is important for when the client is on a mobile screen.
public	onDirty(callback: Function) When this entity's is dirty (mobile) use this callback
public	onReady(callback: Function) When this entity's sprite is loaded trigger this callback
public	setAnimation(name: String, speed: Number, count: Number, onEndCount: Number) Set the animation on this entity
public	setCountdown(count: Number) Set the count for the count down time
public	setGridPosition(x: Number, y: Number) Set the x,y position of the entity on the tile grid
public	setName(name: String) Set the entity's name
public	setPosition(x: Number, y: [type]) Set the x,y position for the entity
public	setSprite(sprite: Sprite) Set the sprite for this entity
public	setVisible(visible: Boolean) Set the visibility on this entity
public	stopBlinking() Tell the entity to stop blinking and force it to be visible
public	toggleVisibility() Toggle the current visibility of this entity

Public Constructors

public constructor(id: Number, kind: String, name: String, count: Number, ability: Ability, abilityLevel: Number) source

Default constructor

Override:

Entity#constructor

Params:

Name	Type	Attribute	Description
id	Number		id of the item
kind	String		type of the item
name	String		name of the item
count	Number		how many
ability	Ability		ability
abilityLevel	Number		ability level

Public Members

public ability: Ability source

Ability

public abilityLevel: Number source

Ability level

public count: Number source

How many

public dropped: Boolean source

If this item was dropped

public shadow: Boolean source

Whether or not it has a shadow

Override:

Entity#shadow

public stackable: Boolean source

If this item is stacked

public type: String source

Type of entity

Public Methods

public hasShadow(): Boolean source

Check if this has a shadow or not

Override:

Entity#hasShadow

Return:

Boolean

public idle() source

Set the idle animation