import Projectile from 'WTF-Adventure/WTF-Adventure/client/entity/objects/projectile.js'

public class | source

Projectile

Extends:

Entity → Projectile

This os an object type of Entity

Constructor Summary

Public Constructor
public	constructor(id: Number, kind: String, owner: Entity, name: String) Default constructor

Member Summary

Public Members
public	angle: Number Angle of the projectile
public	destX: Number X coordinate destination
public	destY: Number Y coordinate destination
public	dynamic: Boolean If this is a dynamic projectile
public	impactCallback: Function Callback function for impact
public	name: String Name of the projectile
public	owner: Entity Owner of this projectile
public	path: Boolean Path of the projectile
public	special: Number If this is a special projectile
public	speed: Number Speed of the projectile
public	startX: Number X coordinate start position
public	startY: Number Y coordinate start position
public	static: Boolean If this is a static projectile

Method Summary

Public Methods
public	getId(): Number Return the ID
public	getSpeed(): Number Gets the speed of the projectile
public	hasPath(): Boolean Return if this has a path
public	impact() Check if this has made an impact
public	onImpact(callback: Function) Set the impact callback
public	setDestination(x: Number, y: Number) Set the projectile destination
public	setStart(x: Number, y: Number) Set the starting point for the projectile
public	setTarget(target: Entity): Boolean Set the target for the projectile
public	updateAngle() Update the angle of the projectile
public	updateTarget(x: Number, y: Number) Update the target location

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, owner: Entity, name: String) source

Default constructor

Override:

Entity#constructor

Params:

Name	Type	Attribute	Description
id	Number		entity id number
kind	String		type of projectile
owner	Entity		who owns this projectile
name	String		name of the projectile

Public Members

public angle: Number source

Angle of the projectile

Override:

Entity#angle

public destX: Number source

X coordinate destination

public destY: Number source

Y coordinate destination

public dynamic: Boolean source

If this is a dynamic projectile

public impactCallback: Function source

Callback function for impact

public name: String source

Name of the projectile

Override:

Entity#name

public owner: Entity source

Owner of this projectile

public path: Boolean source

Path of the projectile

Override:

Entity#path

public special: Number source

If this is a special projectile

public speed: Number source

Speed of the projectile

public startX: Number source

X coordinate start position

public startY: Number source

Y coordinate start position

public static: Boolean source

If this is a static projectile

Public Methods

public getId(): Number source

Return the ID

Return:

Number

public getSpeed(): Number source

Gets the speed of the projectile

Return:

Number

speed of the projectile

public hasPath(): Boolean source

Return if this has a path

Override:

Entity#hasPath

Return:

Boolean

public impact() source

Check if this has made an impact

public onImpact(callback: Function) source

Set the impact callback

Params:

Name	Type	Attribute	Description
callback	Function		what happens if the projectile hits

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

Set the projectile destination

Params:

Name	Type	Attribute	Description
x	Number		x coordinate
y	Number		y coordinate

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

Set the starting point for the projectile

Params:

Name	Type	Attribute	Description
x	Number		x coordinate
y	Number		y coordinate

public setTarget(target: Entity): Boolean source

Set the target for the projectile

Params:

Name	Type	Attribute	Description
target	Entity		the entity this is trying to hit

Return:

Boolean

public updateAngle() source

Update the angle of the projectile

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

Update the target location

Params:

Name	Type	Attribute	Description
x	Number		x coordinate
y	Number		y coordinate