Class Character`Abstract`

Base class used to represent a character

Remarks

Implements the Talk action by default

Hierarchy (View Summary)

GameObject
- Character

Implements

Talk

Index

Constructors

Accessors

Methods

Constructors

`Protected`constructor

new Character(alias: string): Character
Create a new instance of this character
Parameters
- alias: string
  Alias of this character
Returns Character
Overrides GameObject.constructor
- Defined in src/api/src/game-base/gameObjects/Character.ts:16

Accessors

alias

get alias(): string
Get the alias of this game object

Returns string
Inherited from GameObject.alias
- Defined in src/api/src/game-base/gameObjects/GameObject.ts:20

Methods

`Abstract`name

name(): SyncOrAsync<string>
Get the name of this game object

Returns SyncOrAsync<string>
Inherited from GameObject.name
- Defined in src/api/src/game-base/gameObjects/GameObject.ts:27

`Abstract`talk

talk(choiceId?: number): undefined | ActionResult
Execute the Talk action
Parameters
- OptionalchoiceId: number
  ID of the specific choice take into consideration
Returns undefined | ActionResult
Result of the Talk action or undefined if unhandled
Implementation of Talk.talk
- Defined in src/api/src/game-base/gameObjects/Character.ts:23