Pixi’VNClass: RoomStoredClass
Defined in: src/classes/navigation/RoomStoredClass.ts:19
Extends
default
Extended by
Implements
RoomBaseInternalInterface
Constructors
Constructor
> new RoomStoredClass(id, location, activities?): RoomStoredClass
Defined in: src/classes/navigation/RoomStoredClass.ts:24
Parameters
id
string
location
The location where the room is.
activities?
(string | ActivityInterface)[] | { activities: (string | ActivityInterface)[]; routine: (string | CommitmentInterface)[]; }
Returns
RoomStoredClass
Overrides
NavigationAbstractClass.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.
Implementation of
RoomBaseInternalInterface.id
Inherited from
NavigationAbstractClass.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
Implementation of
RoomBaseInternalInterface.activities
Inherited from
NavigationAbstractClass.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[]
Implementation of
RoomBaseInternalInterface.activitiesIds
Inherited from
NavigationAbstractClass.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
Implementation of
RoomBaseInternalInterface.automaticFunctions
characters
Get Signature
> get characters(): CharacterInterface[]
Defined in: src/classes/navigation/RoomStoredClass.ts:96
Get the characters in the room.
Returns
CharacterInterface[]
Implementation of
RoomBaseInternalInterface.characters
location
Get Signature
> get location(): LocationInterface
Defined in: src/classes/navigation/RoomStoredClass.ts:92
The location where the room is.
Returns
Implementation of
RoomBaseInternalInterface.location
routine
Get Signature
> get routine(): CommitmentInterface[]
Defined in: src/classes/navigation/RoomStoredClass.ts:48
Get the character commitments of the room.
Returns
Implementation of
RoomBaseInternalInterface.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
Implementation of
RoomBaseInternalInterface.addActivity
Inherited from
NavigationAbstractClass.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
Implementation of
RoomBaseInternalInterface.addCommitment
clearExpiredActivities()
> clearExpiredActivities(): void
Defined in: src/classes/navigation/NavigationAbstractClass.ts:149
Removes the useless activities.
Returns
void
Implementation of
RoomBaseInternalInterface.clearExpiredActivities
Inherited from
NavigationAbstractClass.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.idImplementation of
RoomBaseInternalInterface.getStorageProperty
Inherited from
NavigationAbstractClass.getStorageProperty
migrateOldStorage()
> protected migrateOldStorage(oldCategoryId?): void
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37
Parameters
oldCategoryId?
string
Returns
void
Implementation of
RoomBaseInternalInterface.migrateOldStorage
Inherited from
NavigationAbstractClass.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
Implementation of
RoomBaseInternalInterface.removeActivity
Inherited from
NavigationAbstractClass.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
Implementation of
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
Implementation of
RoomBaseInternalInterface.setStorageProperty
Inherited from
NavigationAbstractClass.setStorageProperty