Pixi’VNInterface: LocationInterface
Defined in: src/interface/navigation/LocationInterface.ts:5
Extends
LocationInternalInterface
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
LocationInternalInterface.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
LocationInternalInterface.activitiesIds
id
> readonly id: string
Defined in: src/interface/navigation/LocationInterface.ts:11
The id of the location.
Inherited from
LocationInternalInterface.id
map
> readonly map: MapInterface
Defined in: src/interface/navigation/LocationInterface.ts:15
The map where the location is.
Inherited from
LocationInternalInterface.map
rooms
> readonly rooms: RoomInterface[]
Defined in: src/interface/navigation/LocationInterface.ts:20
Get all rooms in the location.
Returns
The rooms in the location.
Inherited from
LocationInternalInterface.rooms
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
LocationInternalInterface.addActivity
clearExpiredActivities()
> clearExpiredActivities(): void
Defined in: src/interface/navigation/NavigationAbstractClass.ts:23
Removes the useless activities.
Returns
void
Inherited from
LocationInternalInterface.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
LocationInternalInterface.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
LocationInternalInterface.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
LocationInternalInterface.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
Inherited from
LocationInternalInterface.setStorageProperty