import Player from 'WTF-Adventure/WTF-Adventure/client/entity/character/player/player.js'

public class | source

Player

Extends:

Entity → Character → Player

A member's playable Character in the game

Constructor Summary

Public Constructor
public	constructor() Default constructor

Member Summary

Public Members
public	armour: Armour The player's armor
public	avatar: [type] Player's avatar
public	boots: Boots The player's boots
public	direction: Number Direction they are facing
public	disableAction: Boolean Are their actions disabled
public	email: String Player's email
public	experience: Number How many experience the player has
public	hitPoints: Number Current health points
public	id: Number The player's ID number
public	lastLogin: String The player's last login
public	level: Number Level of the player
public	mana: Number Current magic points
public	maxHitPoints: Number Maximum health points
public	maxMana: Number Maximum magic points
public	moveDown: Boolean Keyboard moving down
public	moveLeft: Boolean Keyboard moving left
public	moveRight: Boolean Keyboard moving right
public	moveUp: Boolean Keyboard moving up
public	name: [type] The player's name??? not sure
public	password: String Player's password
public	pendant: Pendant The player's pendant
public	prevX: Number Previous grid X position
public	prevY: Number Previous grid Y position
public	pvp: Boolean \| Entity Player that is currently attacking them
public	pvpDeaths: Number How many PVP death's they've had
public	pvpKills: Number How many PVP kills they've had
public	rights: Number Player = 0, moderator = 1, or admin >= 2
public	ring: Ring The player's ring
public	tempBlinkTimeout: Function Timeout for temporary blinking
public	type: String The type of entity this is
public	updateArmourCallback: Function Callback for armor updates
public	username: String Player's username
public	wanted: Boolean Not sure what this is....
public	weapon: Weapon The player's weapon

Method Summary

Public Methods
public	getSpriteName(): String Gets the name of the sprite depending on their equipped armor defaults to `clotharmor` if they don't have anything equipped
public	getX(): Number Get the player's grid X position
public	getY(): Number Get the player's grid Y position
public	hasKeyboardMovement(): Boolean Returns true if there was keyboard movememnt
public	hasWeapon(): Boolean Returns true if the player has a weapon
public	isRanged(): Boolean Returns true if the has a ranged weapon
public	loadEquipment() Loads the player's default (empty) equipment
public	loadHandler(game: Game) This is for other player characters
public	loadPlayer(data: Object) Load equipment for this player given the data response from the server
public	onUpdateArmour(callback: Function) Set the callback for updating armour
public	setEquipment(type: Modules, info: Array) Set the player's equipment from the server
public	setId(id: Number) Sets the ID of the player
public	setMana(mana: Number) Set the player's current mana
public	setMaxMana(maxMana: [type]) Set the player's maximum mana amount
public	setName(name: String) Sets the name and username of the player
public	setPointsData(hitPointsData: Array, manaData: Array) Set the player's health and mana from the server data
public	tempBlink() Temporary blink the entity
public	unequip(type: String) Unequip an item

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

From class Character
public	adjacentTiles: Object Object of adjacent tiles while pathing
public	attackAnimationSpeed: Number Attack animation speed
public	attackRange: Number What is their attack range
public	attackers: Object An array of things trying to attack them
public	attacking: Boolean Are they attacking something
public	beforeStepCallback: Function Before step callback
public	critical: Boolean Did they get a critical hit
public	criticalAnimation: Animation Global critical animation
public	dead: Boolean Are they dead
public	destination: {gridX: Number, gridY: Number} The X and Y locations of the destination
public	explosion: Boolean Did they explode
public	explosionAnimation: Animation Global explosion animation
public	following: Boolean Are they following something
public	forced: Boolean If this character's pathing is being forced
public	frozen: Boolean Are they frozen
public	healthBarTimeout: Boolean Does their health reset after time is up
public	healthBarVisible: Boolean Is there health bar visible or not
public	hitPoints: Number How many hit points they have left
public	hitPointsCallback: Function Hit points callback
public	idleSpeed: Number Idle animation speed
public	interrupted: Boolean Should their action be interrupted
public	mana: Number How much magic they have left
public	maxHitPoints: Number How many hit points they have total
public	maxMana: Number How much magic they have total
public	moveCallback: Function Move callback
public	movement: Transition Movement transitions
public	movementSpeed: Number Movement animation speed
public	newDestination: Object Location of a new destination during pathing
public	nextGridX: Number Next grid X position
public	nextGridY: Number Next grid Y position
public	orientation: Orientation The direction they are pointing
public	path: Astar What is their current path
public	prevGridX: Number Previous gridX position
public	prevGridY: Number Previous gridY position
public	requestPathCallback: Function Request path callback
public	secondStepCallback: Function Second step callback
public	shadow: Boolean Do they have a shadow
public	spriteFlipX: Boolean Flip the sprite along the X axis
public	spriteFlipY: Boolean Flip the sprite along the Y axis
public	startPathingCallback: Function Start pathing callback
public	step: Number Default step number
public	stepCallback: Function Step callback
public	stopPathingCallback: Function Stop pathing callback
public	stunAnimation: Animation Global stun animation
public	stunned: Boolean Are they stunned
public	target: Entity What is their current target
public	terror: Boolean If this character is in terror
public	terrorAnimation: Animation Global terror animation
public	walkAnimationSpeed: Number Walk animation speed
public	weapon: Boolean Do they have a weapon
public	addAttacker(character: Character): Boolean Add an attacker to a character
public	animate(animation: String, speed: Number, count: Number, onEndCount: Function): Null \| Void Animate the character depending on their current orientation
public	attack(attacker: Character, character: Character) Attack a specific character
public	backOff() Stop following or attacking another character
public	changedPath(): [type] Returns true if they've changed paths
public	clearHealthBar() Clear the health bar from the screen
public	follow(character: Character) Follow a specific character
public	followPath(path: Array): Boolean Taken from TTA - this is to ensure the player does not click on himself or somehow into another dimension
public	forEachAttacker(callback: Function) Apply a callback to each attacker
public	forget() Removes all attakers
public	getActiveEffect(): String Return the active effect on the character
public	getEffectAnimation(): String Get the correct effect animation
public	go(x: Number, y: Number, forced: Boolean): Boolean Go to a specific x,y value
public	hasAttacker(character: Character): Boolean Check if they are already being attacked by this character
public	hasNextStep(): Boolean Returns true if they have a next path step
public	hasPath(): Boolean Returns true if they have a path
public	hasShadow(): Boolean Returns true if they have a shadow
public	hasTarget(): Boolean Returns true if they are targeting someone
public	hasWeapon(): Boolean Returns true if they have a weapon
public	idle(direction: Number) Set the idle animation and optional orientation direction
public	isAttacked(): Boolean Check if they are being attacked
public	isMoving(): Boolean Check if the character is currently moving
public	loadGlobals() Load all global character animations
public	lookAt(character: Character) Look at a specific character
public	move(x: Number, y: Number, forced: Boolean) Move the character to a new location
public	moved() The character has moved, trigger the move callback if there is one
public	nextStep(): Boolean We can have the movement remain client side because the server side will be responsible for determining whether or not the player should have reached the location and ban all hackers.
public	onBeforeStep(callback: Function) Before a pathing step callback
public	onHitPoints(callback: Function) On hit points callback
public	onMove(callback: Function) On move callback
public	onRequestPath(callback: Function) Callback for path requested
public	onSecondStep(callback: Function) Second step callback
public	onStartPathing(callback: Function) Start pathing callback
public	onStep(callback: Function) Pathing step callback
public	onStopPathing(callback: Function) Stop pathing callback
public	performAction(orientation: Number, action: Number) Set a specific animation action
public	proceed(x: Number, y: Number) Set a new destination during movement somewhere
public	removeAttacker(character: Character): Boolean Removes an attacker from a character
public	removeTarget(): Boolean Returns true if the target was removed
public	requestPathfinding(x: Number, y: Number): Array Request path finding from current position to this position
public	setHitPoints(hitPoints: Number) Set the character's hit points then triggers hitPointsCallback
public	setMaxHitPoints(maxHitPoints: Number) Set the character's maximum hit points
public	setOrientation(orientation: String) Set the character's orientation
public	setTarget(target: Character) Sets a target for this character
public	stop(force: Boolean) Stop the character movement
public	triggerHealthBar() The triggered health bar (currently fighting)
public	updateGridPosition() Update the character's position on the grid
public	updateMovement() Update movement on the path

Public Constructors

public constructor() source

Default constructor

Override:

Character#constructor

Public Members

public armour: Armour source

The player's armor

public avatar: [type] source

Player's avatar

public boots: Boots source

The player's boots

public direction: Number source

Direction they are facing

public disableAction: Boolean source

Are their actions disabled

public email: String source

Player's email

public experience: Number source

How many experience the player has

public hitPoints: Number source

Current health points

Override:

Character#hitPoints

public id: Number source

The player's ID number

Override:

Entity#id

public lastLogin: String source

The player's last login

public level: Number source

Level of the player

public mana: Number source

Current magic points

Override:

Character#mana

public maxHitPoints: Number source

Maximum health points

Override:

Character#maxHitPoints

public maxMana: Number source

Maximum magic points

Override:

Character#maxMana

public moveDown: Boolean source

Keyboard moving down

public moveLeft: Boolean source

Keyboard moving left

public moveRight: Boolean source

Keyboard moving right

public moveUp: Boolean source

Keyboard moving up

public name: [type] source

The player's name??? not sure

Override:

Entity#name

public password: String source

Player's password

public pendant: Pendant source

The player's pendant

public prevX: Number source

Previous grid X position

public prevY: Number source

Previous grid Y position

public pvp: Boolean | Entity source

Player that is currently attacking them

public pvpDeaths: Number source

How many PVP death's they've had

public pvpKills: Number source

How many PVP kills they've had

public rights: Number source

Player = 0, moderator = 1, or admin >= 2

public ring: Ring source

The player's ring

public tempBlinkTimeout: Function source

Timeout for temporary blinking

public type: String source

The type of entity this is

public updateArmourCallback: Function source

Callback for armor updates

public username: String source

Player's username

public wanted: Boolean source

Not sure what this is.... changes player name label text to red

public weapon: Weapon source

The player's weapon

Override:

Character#weapon

Public Methods

public getSpriteName(): String source

Gets the name of the sprite depending on their equipped armor defaults to clotharmor if they don't have anything equipped

Return:

String

sprite name for the character's armor

public getX(): Number source

Get the player's grid X position

Return:

Number

grid X position

public getY(): Number source

Get the player's grid Y position

Return:

Number

grid Y position

public hasKeyboardMovement(): Boolean source

Returns true if there was keyboard movememnt

Return:

Boolean

public hasWeapon(): Boolean source

Returns true if the player has a weapon

Override:

Character#hasWeapon

Return:

Boolean

public isRanged(): Boolean source

Returns true if the has a ranged weapon

Return:

Boolean

public loadEquipment() source

Loads the player's default (empty) equipment

public loadHandler(game: Game) source

This is for other player characters

Params:

Name	Type	Attribute	Description
game	Game		an instance of the game

public loadPlayer(data: Object) source

Load equipment for this player given the data response from the server

Params:

Name	Type	Attribute	Description
data	Object		player equipment and info from the server
data.instance	Number		ID of the player
data.x	Number		grid X position
data.y	Number		grid Y position
data.hitPoints	Number		current hit points
data.mana	Number		current mana points
data.username	String		the name of the player
data.experience	Number		the player experience points
data.level	Number		the player's level
data.lastLogin	String		the last login date
data.pvpKills	Number		the total pvp kills
data.pvpDeaths	Number		the total pvp deaths

public onUpdateArmour(callback: Function) source

Set the callback for updating armour

Params:

Name	Type	Attribute	Description
callback	Function		function to reset armor

public setEquipment(type: Modules, info: Array) source

Set the player's equipment from the server

Params:

Name	Type	Attribute	Description
type	Modules		values from Modules.Equipment
info	Array		in the format of [ id, name, string, count, ability, abilityLevel ]

public setId(id: Number) source

Sets the ID of the player

Params:

Name	Type	Attribute	Description
id	Number		player ID

public setMana(mana: Number) source

Set the player's current mana

Params:

Name	Type	Attribute	Description
mana	Number		amount

public setMaxMana(maxMana: [type]) source

Set the player's maximum mana amount

Params:

Name	Type	Attribute	Description
maxMana	[type]		amount

public setName(name: String) source

Sets the name and username of the player

Override:

Entity#setName

Params:

Name	Type	Attribute	Description
name	String		username of the player

public setPointsData(hitPointsData: Array, manaData: Array) source

Set the player's health and mana from the server data

Params:

Name	Type	Attribute	Description
hitPointsData	Array		in the format of [ id, hitPoints, maxHitPoints ]
manaData	Array		in the format of [ id, mana, maxMana ]

public tempBlink() source

Temporary blink the entity

public unequip(type: String) source

Unequip an item

Params:

Name	Type	Attribute	Description
type	String		type of equipment to remove