Class: CharacterBaseModel

Defined in: src/characters/classes/CharacterBaseModel.ts:28

CharacterBaseModel is a class that is used to create a character model. You must use the RegisteredCharacters.add function to save the character in the game. It is raccomended to create your own class Character, read more here: https://pixi-vn.web.app/start/character.html#custom-character

Example

export const liam = new CharacterBaseModel('liam', {
    name: 'Liam',
    surname: 'Smith',
    age: 25,
    icon: "https://pixijs.com/assets/eggHead.png",
    color: "#9e2e12"
});
export const alice = new CharacterBaseModel('alice', {
    name: 'Alice',
    surname: 'Smith',
    age: 25,
    icon: "https://pixijs.com/assets/eggHead.png",
    color: "#9e2e12"
});
RegisteredCharacters.add([liam, alice]);

Extends

• CharacterStoredClass

Constructors

Constructor

> new CharacterBaseModel(id, props): CharacterBaseModel

Defined in: src/characters/classes/CharacterBaseModel.ts:33

Parameters

id

string | { emotion: string; id: string; }

The id of the character.

props

CharacterBaseModelProps

The properties of the character.

Returns

CharacterBaseModel

Overrides

CharacterStoredClass.constructor

Properties

id

> readonly id: string

Defined in: src/storage/classes/StoredClassModel.ts:63

Is id of the stored class. is unique for this class.

Inherited from

CharacterStoredClass.id

Accessors

age

Get Signature

> get age(): number | undefined

Defined in: src/characters/classes/CharacterBaseModel.ts:68

The age of the character. If you set undefined, it will return the default age.

Returns

number | undefined

Set Signature

> set age(value): void

Defined in: src/characters/classes/CharacterBaseModel.ts:71

Parameters

value

number | undefined

Returns

void

color

Get Signature

> get color(): string | undefined

Defined in: src/characters/classes/CharacterBaseModel.ts:85

The color of the character.

Returns

string | undefined

icon

Get Signature

> get icon(): string | undefined

Defined in: src/characters/classes/CharacterBaseModel.ts:78

The icon of the character.

Returns

string | undefined

name

Get Signature

> get name(): string

Defined in: src/characters/classes/CharacterBaseModel.ts:46

The name of the character. If you set undefined, it will return the default name.

Returns

string

Set Signature

> set name(value): void

Defined in: src/characters/classes/CharacterBaseModel.ts:49

Parameters

value

string | undefined

Returns

void

surname

Get Signature

> get surname(): string | undefined

Defined in: src/characters/classes/CharacterBaseModel.ts:57

The surname of the character. If you set undefined, it will return the default surname.

Returns

string | undefined

Set Signature

> set surname(value): void

Defined in: src/characters/classes/CharacterBaseModel.ts:60

Parameters

value

string | undefined

Returns

void

Methods

getStorageProperty()

> getStorageProperty<T>(propertyName): T | undefined

Defined in: src/characters/classes/CharacterStoredClass.ts:16

Get a property from the storage.

Type Parameters

T

T

Parameters

propertyName

string

The name of the property to get.

Returns

T | undefined

The value of the property. If the property is not found, returns undefined.

Default

this.id

Inherited from

CharacterStoredClass.getStorageProperty

migrateOldStorage()

> protected migrateOldStorage(oldCategoryId?): void

Defined in: src/storage/classes/StoredClassModel.ts:43

Parameters

oldCategoryId?

string = ...

Returns

void

Inherited from

CharacterStoredClass.migrateOldStorage

~~setStorageProperty()~~

> protected setStorageProperty<T>(propertyName, value): void

Defined in: src/storage/classes/StoredClassModel.ts:68

Type Parameters

T

T

Parameters

propertyName

string

value

StorageElementType

Returns

void

Deprecated

Remove the type parameter, it is not needed and it is not used in the implementation.

Inherited from

CharacterStoredClass.setStorageProperty