import PickCharacter from 'WTF-Adventure/WTF-Adventure/client/controllers/pickcharacter.js'

public class | source

PickCharacter

Used to load the character and items for the player

Constructor Summary

Public Constructor
public	constructor(game: Game) Default constructor

Member Summary

Public Members
public	decrepit: Object
public	entities: Array A reference to the entities in the game
public	game: Game Instance of the game
public	grids: [type] Grids
public	renderer: Renderer Instance of the renderer
public	sprites: Sprites A reference to other game sprites in the game

Method Summary

Public Methods
public	addEntity(entity: Entity) Adds an entity
public	clearPlayers(exception: Player) Clears the other players from the grid to calculate pathing so they don't collide, then resets the players back into position
public	create() Create the player in the game
public	exists(id: Number): * Checks to see if an entity is there
public	forEachEntity(callback: Function) Apply a callback function to every entity
public	forEachEntityAround(x: Number, y: Number, radius: Number, callback: Function) Apply a callback function to entities within a position radius
public	get(id: Number): Entity Return a specific entity by index
public	getAll(): Entity[] Returns all available entities
public	getSprite(name: String): Sprite Get a sprite by name
public	loadCharacter() Load the character into the game
public	registerDuality(entity: Entity) Register position with duality (two things in the same spot) so the entity is moved to a different spot
public	registerPosition(entity: Entity) Register the position of an entity and add it to the player's grid
public	removeItem(item: Item) Remove an item from the game
public	unregisterPosition(entity: Entity) Remove an entity from a position on the grids
public	update() Updating sprites in the game

Public Constructors

public constructor(game: Game) source

Default constructor

Params:

Name	Type	Attribute	Description
game	Game		Reference to the game class

Public Members

public decrepit: Object source

public entities: Array source

A reference to the entities in the game

public game: Game source

Instance of the game

public grids: [type] source

Grids

public renderer: Renderer source

Instance of the renderer

public sprites: Sprites source

A reference to other game sprites in the game

Public Methods

public addEntity(entity: Entity) source

Adds an entity

Params:

Name	Type	Attribute	Description
entity	Entity		instance of the entity to add

public clearPlayers(exception: Player) source

Clears the other players from the grid to calculate pathing so they don't collide, then resets the players back into position

Params:

Name	Type	Attribute	Description
exception	Player		Player to exlude when clearing

public create() source

Create the player in the game

public exists(id: Number): * source

Checks to see if an entity is there

Params:

Name	Type	Attribute	Description
id	Number		The ID of the entity

Return:

{Entity

public forEachEntity(callback: Function) source

Apply a callback function to every entity

Params:

Name	Type	Attribute	Description
callback	Function		the function to apply to every entity

public forEachEntityAround(x: Number, y: Number, radius: Number, callback: Function) source

Apply a callback function to entities within a position radius

Params:

Name	Type	Attribute	Description
x	Number		X coordinate in the grid
y	Number		Y coordinate in the grids
radius	Number		How many grid spaces in the circle radius
callback	Function		The callback function to apply

public get(id: Number): Entity source

Return a specific entity by index

Params:

Name	Type	Attribute	Description
id	Number		returns an entity with that ID

Return:

Entity

public getAll(): Entity[] source

Returns all available entities

Return:

Entity[]

array of entities

public getSprite(name: String): Sprite source

Get a sprite by name

Params:

Name	Type	Attribute	Description
name	String		the name of the sprite

Return:

Sprite

returns the sprite if found

public loadCharacter() source

Load the character into the game

public registerDuality(entity: Entity) source

Params:

Name	Type	Attribute	Description
entity	Entity		An instance of an entity

public registerPosition(entity: Entity) source

Params:

Name	Type	Attribute	Description
entity	Entity		An instance of a player, mob, npc or chest

public removeItem(item: Item) source

Remove an item from the game

Params:

Name	Type	Attribute	Description
item	Item		An instance of an item

public unregisterPosition(entity: Entity) source

Remove an entity from a position on the grids

Params:

Name	Type	Attribute	Description
entity	Entity		remove the entity from the grid

public update() source

Updating sprites in the game