# Class: MapBaseModel (/jsdoc/nqtr/index/classes/MapBaseModel) Defined in: [src/classes/navigation/MapBaseModel.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L15) The base model of a map. I suggest you extend this class to create your own map model. ## Example [#example] ```typescript export const mainMap = new MapBaseModel('main_map', { name: 'Main Map', image: "https://image.jpg", }); ``` ## Extends [#extends] * [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass) ## Implements [#implements] * `MapBaseInternalInterface` ## Constructors [#constructors] ### Constructor [#constructor] \> **new MapBaseModel**(`id`, `props?`): `MapBaseModel` Defined in: [src/classes/navigation/MapBaseModel.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L20) #### Parameters [#parameters] ##### id [#id] `string` The id of the map, it must be unique. ##### props? [#props] [`MapBaseModelProps`](/jsdoc/nqtr/index/interfaces/MapBaseModelProps) = `{}` The properties of the map. #### Returns [#returns] `MapBaseModel` #### Overrides [#overrides] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`constructor`](/jsdoc/nqtr/index/classes/MapStoredClass#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] `MapBaseInternalInterface.id` #### Inherited from [#inherited-from] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`id`](/jsdoc/nqtr/index/classes/MapStoredClass#id) ## Accessors [#accessors] ### activities [#activities] #### 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] `MapBaseInternalInterface.activities` #### Inherited from [#inherited-from-1] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`activities`](/jsdoc/nqtr/index/classes/MapStoredClass#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] `MapBaseInternalInterface.activitiesIds` #### Inherited from [#inherited-from-2] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`activitiesIds`](/jsdoc/nqtr/index/classes/MapStoredClass#activitiesids) *** ### image [#image] #### Get Signature [#get-signature-2] \> **get** **image**(): `string` | `undefined` Defined in: [src/classes/navigation/MapBaseModel.ts:42](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L42) The image of the map. ##### Returns [#returns-3] `string` | `undefined` *** ### locations [#locations] #### Get Signature [#get-signature-3] \> **get** **locations**(): [`LocationInterface`](/jsdoc/nqtr/index/interfaces/LocationInterface)\[] Defined in: [src/classes/navigation/MapStoredClass.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapStoredClass.ts#L15) Get all locations in the map. ##### Returns [#returns-4] [`LocationInterface`](/jsdoc/nqtr/index/interfaces/LocationInterface)\[] The locations in the map. #### Implementation of [#implementation-of-3] `MapBaseInternalInterface.locations` #### Inherited from [#inherited-from-3] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`locations`](/jsdoc/nqtr/index/classes/MapStoredClass#locations) *** ### name [#name] #### Get Signature [#get-signature-4] \> **get** **name**(): `string` Defined in: [src/classes/navigation/MapBaseModel.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L31) The name of the map. If you set undefined, it will return the initial value of name. ##### Returns [#returns-5] `string` #### Set Signature [#set-signature] \> **set** **name**(`value`): `void` Defined in: [src/classes/navigation/MapBaseModel.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L34) ##### Parameters [#parameters-1] ###### value [#value] `string` | `undefined` ##### Returns [#returns-6] `void` ## 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-2] ##### 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-4] `MapBaseInternalInterface.addActivity` #### Inherited from [#inherited-from-4] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`addActivity`](/jsdoc/nqtr/index/classes/MapStoredClass#addactivity) *** ### 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-8] `void` #### Implementation of [#implementation-of-5] `MapBaseInternalInterface.clearExpiredActivities` #### Inherited from [#inherited-from-5] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`clearExpiredActivities`](/jsdoc/nqtr/index/classes/MapStoredClass#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-9] `T` | `undefined` The value of the property. If the property is not found, returns undefined. #### Default [#default] ```ts this.id ``` #### Implementation of [#implementation-of-6] `MapBaseInternalInterface.getStorageProperty` #### Inherited from [#inherited-from-6] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`getStorageProperty`](/jsdoc/nqtr/index/classes/MapStoredClass#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-10] `void` #### Implementation of [#implementation-of-7] `MapBaseInternalInterface.migrateOldStorage` #### Inherited from [#inherited-from-7] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`migrateOldStorage`](/jsdoc/nqtr/index/classes/MapStoredClass#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-11] `void` #### Implementation of [#implementation-of-8] `MapBaseInternalInterface.removeActivity` #### Inherited from [#inherited-from-8] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`removeActivity`](/jsdoc/nqtr/index/classes/MapStoredClass#removeactivity) *** ### 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-6] ##### propertyName [#propertyname-1] `string` The name of the property to set. ##### value [#value-1] `StorageElementType` The value to set. If is undefined, the property will be removed from the storage. #### Returns [#returns-12] `void` #### Implementation of [#implementation-of-9] `MapBaseInternalInterface.setStorageProperty` #### Inherited from [#inherited-from-9] [`MapStoredClass`](/jsdoc/nqtr/index/classes/MapStoredClass).[`setStorageProperty`](/jsdoc/nqtr/index/classes/MapStoredClass#setstorageproperty)