Pixi’VNInterface: RoomInterface
Defined in: src/interface/navigation/RoomInterface.ts:8
Extends
RoomBaseInternalInterface
Properties
activities
> activities: ActivityInterface[]
Defined in: src/interface/navigation/NavigationAbstractClass.ts:31
The activities associated with this class, filtered based on their scheduling.
Inherited from
RoomBaseInternalInterface.activities
activitiesIds
> readonly activitiesIds: string[]
Defined in: src/interface/navigation/NavigationAbstractClass.ts:27
All the ids of the activities associated with this class. Compared to activities, they are not filtered based on their scheduling.
Inherited from
RoomBaseInternalInterface.activitiesIds
automaticFunctions
> readonly automaticFunctions: OnRunAsyncFunction[]
Defined in: src/interface/navigation/RoomInterface.ts:46
Get the functions that will be executed when the room is visited.
Inherited from
RoomBaseInternalInterface.automaticFunctions
characters
> readonly characters: CharacterInterface[]
Defined in: src/interface/navigation/RoomInterface.ts:42
Get the characters in the room.
Inherited from
RoomBaseInternalInterface.characters
id
> readonly id: string
Defined in: src/interface/navigation/RoomInterface.ts:14
The id of the room.
Inherited from
RoomBaseInternalInterface.id
location
> readonly location: LocationInterface
Defined in: src/interface/navigation/RoomInterface.ts:18
The location where the room is.
Inherited from
RoomBaseInternalInterface.location
routine
> readonly routine: CommitmentInterface[]
Defined in: src/interface/navigation/RoomInterface.ts:38
Get the character commitments of the room.
Inherited from
RoomBaseInternalInterface.routine
Methods
addActivity()
> addActivity(activity, options?): void
Defined in: src/interface/navigation/NavigationAbstractClass.ts:13
Connects the activity to the class.
Parameters
activity
string | ActivityInterface
The activity to connect to the class.
options?
Returns
void
Inherited from
RoomBaseInternalInterface.addActivity
addCommitment()
> addCommitment(commitment, options?): void
Defined in: src/interface/navigation/RoomInterface.ts:25
Connects the commitment to the class.
Parameters
commitment
string | CommitmentInterface
The commitment to connect to the class.
options?
Returns
void
Inherited from
RoomBaseInternalInterface.addCommitment
clearExpiredActivities()
> clearExpiredActivities(): void
Defined in: src/interface/navigation/NavigationAbstractClass.ts:23
Removes the useless activities.
Returns
void
Inherited from
RoomBaseInternalInterface.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.idInherited from
RoomBaseInternalInterface.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
RoomBaseInternalInterface.migrateOldStorage
removeActivity()
> removeActivity(activity): void
Defined in: src/interface/navigation/NavigationAbstractClass.ts:19
Disconnects the activity from the class.
Parameters
activity
string | ActivityInterface
The activity to disconnect from the class.
Returns
void
Inherited from
RoomBaseInternalInterface.removeActivity
removeCommitment()
> removeCommitment(commitment): void
Defined in: src/interface/navigation/RoomInterface.ts:34
Disconnects the commitment from the class.
Parameters
commitment
string | CommitmentInterface
The commitment to disconnect from the class.
Returns
void
Inherited from
RoomBaseInternalInterface.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
RoomBaseInternalInterface.setStorageProperty