# Class: RoomStoredClass (/jsdoc/nqtr/index/classes/RoomStoredClass)



Defined in: [src/classes/navigation/RoomStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L19)

## Extends [#extends]

* `default`

## Extended by [#extended-by]

* [`RoomBaseModel`](/jsdoc/nqtr/index/classes/RoomBaseModel)

## Implements [#implements]

* `RoomBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new RoomStoredClass**(`id`, `location`, `activities?`): `RoomStoredClass`

Defined in: [src/classes/navigation/RoomStoredClass.ts:24](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L24)

#### Parameters [#parameters]

##### id [#id]

`string`

##### location [#location]

[`LocationInterface`](/jsdoc/nqtr/index/interfaces/LocationInterface)

The location where the room is.

##### activities? [#activities]

(`string` | [`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface))\[] | \{ `activities`: (`string` | [`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface))\[]; `routine`: (`string` | [`CommitmentInterface`](/jsdoc/nqtr/index/interfaces/CommitmentInterface))\[]; }

#### Returns [#returns]

`RoomStoredClass`

#### Overrides [#overrides]

`NavigationAbstractClass.constructor`

## Properties [#properties]

### id [#id-1]

\> `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 [#implementation-of]

`RoomBaseInternalInterface.id`

#### Inherited from [#inherited-from]

`NavigationAbstractClass.id`

## Accessors [#accessors]

### activities [#activities-1]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

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

##### Returns [#returns-1]

[`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)\[]

#### Implementation of [#implementation-of-1]

`RoomBaseInternalInterface.activities`

#### Inherited from [#inherited-from-1]

`NavigationAbstractClass.activities`

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/jsdoc/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Implementation of [#implementation-of-2]

`RoomBaseInternalInterface.activitiesIds`

#### Inherited from [#inherited-from-2]

`NavigationAbstractClass.activitiesIds`

***

### automaticFunctions [#automaticfunctions]

#### Get Signature [#get-signature-2]

\> **get** **automaticFunctions**(): [`OnRunAsyncFunction`](/jsdoc/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:103](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L103)

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

##### Returns [#returns-3]

[`OnRunAsyncFunction`](/jsdoc/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

#### Implementation of [#implementation-of-3]

`RoomBaseInternalInterface.automaticFunctions`

***

### characters [#characters]

#### Get Signature [#get-signature-3]

\> **get** **characters**(): `CharacterInterface`\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:96](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L96)

Get the characters in the room.

##### Returns [#returns-4]

`CharacterInterface`\[]

#### Implementation of [#implementation-of-4]

`RoomBaseInternalInterface.characters`

***

### location [#location-1]

#### Get Signature [#get-signature-4]

\> **get** **location**(): [`LocationInterface`](/jsdoc/nqtr/index/interfaces/LocationInterface)

Defined in: [src/classes/navigation/RoomStoredClass.ts:92](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L92)

The location where the room is.

##### Returns [#returns-5]

[`LocationInterface`](/jsdoc/nqtr/index/interfaces/LocationInterface)

#### Implementation of [#implementation-of-5]

`RoomBaseInternalInterface.location`

***

### routine [#routine]

#### Get Signature [#get-signature-5]

\> **get** **routine**(): [`CommitmentInterface`](/jsdoc/nqtr/index/interfaces/CommitmentInterface)\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L48)

Get the character commitments of the room.

##### Returns [#returns-6]

[`CommitmentInterface`](/jsdoc/nqtr/index/interfaces/CommitmentInterface)\[]

#### Implementation of [#implementation-of-6]

`RoomBaseInternalInterface.routine`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-1]

##### activity [#activity]

`string` | [`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/jsdoc/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-7]

`RoomBaseInternalInterface.addActivity`

#### Inherited from [#inherited-from-3]

`NavigationAbstractClass.addActivity`

***

### addCommitment() [#addcommitment]

\> **addCommitment**(`commitment`, `options?`): `void`

Defined in: [src/classes/navigation/RoomStoredClass.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L51)

Connects the commitment to the class.

#### Parameters [#parameters-2]

##### commitment [#commitment]

`string` | [`CommitmentInterface`](/jsdoc/nqtr/index/interfaces/CommitmentInterface)

The commitment to connect to the class.

##### options? [#options-1]

[`ActiveScheduling`](/jsdoc/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-8]

`RoomBaseInternalInterface.addCommitment`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-9]

`void`

#### Implementation of [#implementation-of-9]

`RoomBaseInternalInterface.clearExpiredActivities`

#### Inherited from [#inherited-from-4]

`NavigationAbstractClass.clearExpiredActivities`

***

### getStorageProperty() [#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 [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-3]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-10]

`T` | `undefined`

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

#### Default [#default]

```ts
this.id
```

#### Implementation of [#implementation-of-10]

`RoomBaseInternalInterface.getStorageProperty`

#### Inherited from [#inherited-from-5]

`NavigationAbstractClass.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

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

#### Parameters [#parameters-4]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-11]

`void`

#### Implementation of [#implementation-of-11]

`RoomBaseInternalInterface.migrateOldStorage`

#### Inherited from [#inherited-from-6]

`NavigationAbstractClass.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-5]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-12]

`void`

#### Implementation of [#implementation-of-12]

`RoomBaseInternalInterface.removeActivity`

#### Inherited from [#inherited-from-7]

`NavigationAbstractClass.removeActivity`

***

### removeCommitment() [#removecommitment]

\> **removeCommitment**(`commitment`): `void`

Defined in: [src/classes/navigation/RoomStoredClass.ts:88](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L88)

Disconnects the commitment from the class.

#### Parameters [#parameters-6]

##### commitment [#commitment-1]

`string` | [`CommitmentInterface`](/jsdoc/nqtr/index/interfaces/CommitmentInterface)

The commitment to disconnect from the class.

#### Returns [#returns-13]

`void`

#### Implementation of [#implementation-of-13]

`RoomBaseInternalInterface.removeCommitment`

***

### setStorageProperty() [#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 [#type-parameters-1]

##### T [#t-1]

`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 [#parameters-7]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

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

#### Returns [#returns-14]

`void`

#### Implementation of [#implementation-of-14]

`RoomBaseInternalInterface.setStorageProperty`

#### Inherited from [#inherited-from-8]

`NavigationAbstractClass.setStorageProperty`