Class: RoomBaseModel

Defined in: src/classes/navigation/RoomBaseModel.ts:19

The base model of a room. I suggest you extend this class to create your own room model. You must use the RegisteredRooms.add function to save the room in the registered rooms.

Example

export const mcRoom = new RoomBaseModel('mc_room', mcHome, {
    name: "MC Room",
    icon: "https://icon.jpg",
    image: "https://image.jpg",
})
RegisteredRooms.add(mcRoom)

Extends

• RoomStoredClass

Constructors

Constructor

> new RoomBaseModel(id, location, props?): RoomBaseModel

Defined in: src/classes/navigation/RoomBaseModel.ts:25

Parameters

id

string

The id of the room, it must be unique.

location

LocationInterface

The location where the room is.

props?

RoomBaseModelProps = {}

The properties of the room.

Returns

RoomBaseModel

Overrides

RoomStoredClass.constructor

Properties

id

> readonly id: string

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

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

Inherited from

RoomStoredClass.id

Accessors

activities

Get Signature

> get activities(): ActivityInterface[]

Defined in: src/classes/navigation/NavigationAbstractClass.ts:176

The activities associated with this class, filtered based on their scheduling.

Returns

ActivityInterface[]

Inherited from

RoomStoredClass.activities

activitiesIds

Get Signature

> get activitiesIds(): string[]

Defined in: src/classes/navigation/NavigationAbstractClass.ts:69

All the ids of the activities associated with this class. Compared to activities, they are not filtered based on their scheduling.

Returns

string[]

Inherited from

RoomStoredClass.activitiesIds

automaticFunctions

Get Signature

> get automaticFunctions(): OnRunAsyncFunction[]

Defined in: src/classes/navigation/RoomStoredClass.ts:103

Get the functions that will be executed when the room is visited.

Returns

OnRunAsyncFunction[]

Inherited from

RoomStoredClass.automaticFunctions

characters

Get Signature

> get characters(): CharacterInterface[]

Defined in: src/classes/navigation/RoomStoredClass.ts:96

Get the characters in the room.

Returns

CharacterInterface[]

Inherited from

RoomStoredClass.characters

disabled

Get Signature

> get disabled(): boolean

Defined in: src/classes/navigation/RoomBaseModel.ts:61

Whether is disabled. If it is a string, it is a Pixi'VN flag name.

Returns

boolean

Set Signature

> set disabled(value): void

Defined in: src/classes/navigation/RoomBaseModel.ts:68

Parameters

value

string | boolean

Returns

void

hidden

Get Signature

> get hidden(): boolean

Defined in: src/classes/navigation/RoomBaseModel.ts:76

Whether is hidden. If it is a string, it is a Pixi'VN flag name.

Returns

boolean

Set Signature

> set hidden(value): void

Defined in: src/classes/navigation/RoomBaseModel.ts:83

Parameters

value

string | boolean

Returns

void

icon

Get Signature

> get icon(): string | undefined

Defined in: src/classes/navigation/RoomBaseModel.ts:91

The function for rendering the icon of the room.

Returns

string | undefined

image

Get Signature

> get image(): string | undefined

Defined in: src/classes/navigation/RoomBaseModel.ts:53

The image of the room.

Returns

string | undefined

location

Get Signature

> get location(): LocationInterface

Defined in: src/classes/navigation/RoomStoredClass.ts:92

The location where the room is.

Returns

LocationInterface

Inherited from

RoomStoredClass.location

name

Get Signature

> get name(): string

Defined in: src/classes/navigation/RoomBaseModel.ts:42

The name. If you set undefined, it will return the initial value of name.

Returns

string

Set Signature

> set name(value): void

Defined in: src/classes/navigation/RoomBaseModel.ts:45

Parameters

value

string | undefined

Returns

void

routine

Get Signature

> get routine(): CommitmentInterface[]

Defined in: src/classes/navigation/RoomStoredClass.ts:48

Get the character commitments of the room.

Returns

CommitmentInterface[]

Inherited from

RoomStoredClass.routine

Methods

addActivity()

> addActivity(activity, options?): void

Defined in: src/classes/navigation/NavigationAbstractClass.ts:72

Connects the activity to the class.

Parameters

activity

string | ActivityInterface

The activity to connect to the class.

options?

ActiveScheduling = {}

Returns

void

Inherited from

RoomStoredClass.addActivity

addCommitment()

> addCommitment(commitment, options?): void

Defined in: src/classes/navigation/RoomStoredClass.ts:51

Connects the commitment to the class.

Parameters

commitment

string | CommitmentInterface

The commitment to connect to the class.

options?

ActiveScheduling = {}

Returns

void

Inherited from

RoomStoredClass.addCommitment

clearExpiredActivities()

> clearExpiredActivities(): void

Defined in: src/classes/navigation/NavigationAbstractClass.ts:149

Removes the useless activities.

Returns

void

Inherited from

RoomStoredClass.clearExpiredActivities

getStorageProperty()

> protected getStorageProperty<T>(propertyName, idToUse?): T | undefined

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

Type Parameters

T

T = StorageElementType

Parameters

propertyName

string

The name of the property to get.

idToUse?

string

The id of the instance to get the property.

Returns

T | undefined

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

Default

this.id

Inherited from

RoomStoredClass.getStorageProperty

migrateOldStorage()

> protected migrateOldStorage(oldCategoryId?): void

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

Parameters

oldCategoryId?

string

Returns

void

Inherited from

RoomStoredClass.migrateOldStorage

removeActivity()

> removeActivity(activity): void

Defined in: src/classes/navigation/NavigationAbstractClass.ts:134

Disconnects the activity from the class.

Parameters

activity

string | ActivityInterface

The activity to disconnect from the class.

Returns

void

Inherited from

RoomStoredClass.removeActivity

removeCommitment()

> removeCommitment(commitment): void

Defined in: src/classes/navigation/RoomStoredClass.ts:88

Disconnects the commitment from the class.

Parameters

commitment

string | CommitmentInterface

The commitment to disconnect from the class.

Returns

void

Inherited from

RoomStoredClass.removeCommitment

setStorageProperty()

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

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

Type Parameters

T

T

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

Parameters

propertyName

string

The name of the property to set.

value

StorageElementType

The value to set. If is undefined, the property will be removed from the storage.

Returns

void

Inherited from

RoomStoredClass.setStorageProperty