import Entity from 'WTF-Adventure/WTF-Adventure/client/entity/entity.js'

public class | source

Entity

Direct Subclass:

Character, Chest, Item, Projectile

Indirect Subclass:

Mob, Npc, Player

Initialize a new entity:

Example:

const myEntity = new Entity(1, 'player');

Constructor Summary

Public Constructor
public	constructor(id: Number, kind: String, label: String) Constructor to initialize a new entity

Member Summary

Public Members
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

Method Summary

Public Methods
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, label: String) source

Constructor to initialize a new entity

Params:

Name	Type	Attribute	Description
id	Number		the entity id
kind	String		the type of entity this is
label	String		a name for the entity this is

Public Members

public angle: Number source

Angle of the entity

public angled: Boolean source

[angled description]

public animations: Animation source

Animations for the sprite

public blinking: Function source

Timeout function for blinking

public countdownTime: Number source

Count down time

public counter: Number source

Current counter

public critical: Boolean source

Critical health

public currentAnimation: String source

Current animation the sprite should be playing

public dirty: Boolean source

Set if the entity is dirty

public dirtyCallback: Function source

Callback for when the entity is dirty

public fading: Boolean source

Whether or not this is fading

public fadingTime: Number source

Fading time

public gridX: Number source

Grid X position

public gridY: Number source

Grid Y position

public handler: EntityHandler source

Handler for the entity

public hasCounter: Boolean source

Has a counter

public hurtSprite: String source

Hurt sprite name

public id: Number source

Entity id

public label: String source

Label for the entity

public name: String source

Name of the entity

public nonPathable: Boolean source

Non pathable

public normalSprite: String source

Normal sprite name

public path: Boolean source

Path

public readyCallback: Function source

CAllback function when the entity is ready

public renderingData: Object source

Rendering data

public shadow: Boolean source

Has a shadow

public shadowOffsetY: Number source

Offset for the shadow on the Y axis

public sprite: Sprite source

Sprite

public spriteFlipX: Boolean source

Whether or not to flip the sprite on the X axis

public spriteFlipY: Boolean source

Whether or not to flip the sprite on the Y axis

public spriteLoaded: Boolean source

Whether or not the sprite has been loaded

public stunned: Boolean source

Stunned status

public terror: Boolean source

Terror status

public visible: Boolean source

Wehther or not this entity is visible

public x: Number source

X coordinate

public y: Number source

Y coordinate

Public Methods

public blink(speed: Number) source

Tell this entity to start blinking

Params:

Name	Type	Attribute	Description
speed	Number		the interval time between blinks

public fadeIn(time: Number) source

Tell this to fade in given the duration

Params:

Name	Type	Attribute	Description
time	Number		the amount of time to fade in

public getAnimationByName(name: String): Animation | null source

Look for an animtions list for this specific animation given it's name

Params:

Name	Type	Attribute	Description
name	String		the name of the animation

Return:

Animation | null

returns the animation object or null if not found

public getCoordDistance(toX: Number, toY: Number): Number source

Get the distance from this entity to the given x,y coordinates

Params:

Name	Type	Attribute	Description
toX	Number		the x coordinate
toY	Number		the y coordinate

Return:

Number

the further x or y distance to this coordinate

public getDistance(entity: Entity): Number source

Get the distance from this entity to another entity

Params:

Name	Type	Attribute	Description
entity	Entity		the entity you want to get the distance to

Return:

Number

the furtherst x or y distance from the given entity

public getSprite(): String source

Returns the name of the sprite

Return:

String

the name of the sprite

public hasPath(): Object source

Check if this entity currently has a path

Return:

Object

returns the entity's path

public hasShadow(): Object source

Check whether or not this entity has a shadow

Return:

Object

returns the entity's shadow

public hasWeapon(): Item | Projectile source

Returns the instance of the weapon this entity has

Return:

Item | Projectile

a weapon or projectile

public inAttackRadius(entity: Entity): Boolean source

Figure out if this entity is within the attack radius of the given entity

Params:

Name	Type	Attribute	Description
entity	Entity		Player\|Mob\|Character\|NPC

Return:

Boolean

returns true if they are within the entity's attack radius, if the entity has no attack radius default to 2 grid cells

public inExtraAttackRadius(entity: Entity): Boolean source

Figure out if this entity is within the extended attack radius of the given entity

Params:

Name	Type	Attribute	Description
entity	Entity		Player\|Mob\|Character\|NPC

Return:

Boolean

returns true if they are within the entity's attack radius, if the entity has no attack radius default to 3 grid cells

public isPositionAdjacent(x: Number, y: Number, ignoreDiagonals: Boolean): Boolean source

Checks to see if the x,y coordinate is adjacent to the entity's current position

Params:

Name	Type	Attribute	Description
x	Number		coordinate
y	Number		coordinate
ignoreDiagonals	Boolean		if true, will ignore diagonal directions, defaults to false (optional)

Return:

Boolean

public isVisible(): Boolean source

Check whether or not this entity is visible

Return:

Boolean

returns true if visibile

public loadDirty() source

This is important for when the client is on a mobile screen. So the sprite has to be handled differently.

public onDirty(callback: Function) source

When this entity's is dirty (mobile) use this callback

Params:

Name	Type	Attribute	Description
callback	Function		the function to call when the sprite isDirty

public onReady(callback: Function) source

When this entity's sprite is loaded trigger this callback

Params:

Name	Type	Attribute	Description
callback	Function		the function to call when the sprite is loaded

public setAnimation(name: String, speed: Number, count: Number, onEndCount: Number) source

Set the animation on this entity

Params:

Name	Type	Attribute	Description
name	String		the name of the animation
speed	Number		the animation speed
count	Number		how many times to play the animation
onEndCount	Number		callback to trigger when the animation ends after count number of times

public setCountdown(count: Number) source

Set the count for the count down time

Params:

Name	Type	Attribute	Description
count	Number		sets the counter

public setGridPosition(x: Number, y: Number) source

Set the x,y position of the entity on the tile grid

Params:

Name	Type	Attribute	Description
x	Number		the gridX
y	Number		the gridY

public setName(name: String) source

Set the entity's name

Params:

Name	Type	Attribute	Description
name	String		the name of this entity

public setPosition(x: Number, y: [type]) source

Set the x,y position for the entity

Params:

Name	Type	Attribute	Description
x	Number		the x position on the screen
y	[type]		the y position on the screen

public setSprite(sprite: Sprite) source

Set the sprite for this entity

Params:

Name	Type	Attribute	Description
sprite	Sprite		the sprite for this entity

public setVisible(visible: Boolean) source

Set the visibility on this entity

Params:

Name	Type	Attribute	Description
visible	Boolean		true\|false

public stopBlinking() source

Tell the entity to stop blinking and force it to be visible

public toggleVisibility() source

Toggle the current visibility of this entity