Pixi’VNClass: LocationStoredClass
Defined in: src/classes/navigation/LocationStoredClass.ts:7
Extends
default
Extended by
Implements
LocationInternalInterface
Constructors
Constructor
> new LocationStoredClass(id, _map, activities?): LocationStoredClass
Defined in: src/classes/navigation/LocationStoredClass.ts:11
Parameters
id
string
_map
The map where the location is.
activities?
(string | ActivityInterface)[] = []
Returns
LocationStoredClass
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
LocationInternalInterface.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
LocationInternalInterface.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
LocationInternalInterface.activitiesIds
Inherited from
NavigationAbstractClass.activitiesIds
map
Get Signature
> get map(): MapInterface
Defined in: src/classes/navigation/LocationStoredClass.ts:22
The map where the location is.
Returns
Implementation of
LocationInternalInterface.map
rooms
Get Signature
> get rooms(): RoomInterface[]
Defined in: src/classes/navigation/LocationStoredClass.ts:26
Get all rooms in the location.
Returns
The rooms in the location.
Implementation of
LocationInternalInterface.rooms
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
LocationInternalInterface.addActivity
Inherited from
NavigationAbstractClass.addActivity
clearExpiredActivities()
> clearExpiredActivities(): void
Defined in: src/classes/navigation/NavigationAbstractClass.ts:149
Removes the useless activities.
Returns
void
Implementation of
LocationInternalInterface.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
LocationInternalInterface.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
LocationInternalInterface.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
LocationInternalInterface.removeActivity
Inherited from
NavigationAbstractClass.removeActivity
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
LocationInternalInterface.setStorageProperty
Inherited from
NavigationAbstractClass.setStorageProperty