# Class: ActivityBaseModel (/jsdoc/nqtr/index/classes/ActivityBaseModel) Defined in: [src/classes/activity/ActivityBaseModel.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L31) The activity model. It is used to create an activity. ## Example [#example] ```tsx export const nap = new ActivityModel("nap", (_, event) => { if (event) { event.navigate("/game") callLabelWithGoNavigationCallBack(napLabel, event) } else { console.error("Event is undefined") } }, { name: "Nap", timeSlot: { from: 5, to: 23, }, icon: "https://icon.jpg", } ) ``` ## Extends [#extends] * [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass)\<[`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)> ## Constructors [#constructors] ### Constructor [#constructor] \> **new ActivityBaseModel**(`id`, `onRun`, `props`): `ActivityBaseModel` Defined in: [src/classes/activity/ActivityBaseModel.ts:37](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L37) #### Parameters [#parameters] ##### id [#id] `string` The activity id, that must be unique. ##### onRun [#onrun] [`OnRunEvent`](/jsdoc/nqtr/index/type-aliases/OnRunEvent)\<[`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)> The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function. ##### props [#props] [`ActivityProps`](/jsdoc/nqtr/index/interfaces/ActivityProps) The activity properties. #### Returns [#returns] `ActivityBaseModel` #### Overrides [#overrides] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`constructor`](/jsdoc/nqtr/index/classes/ActivityStoredClass#constructor) ## Properties [#properties] ### \_onRun [#_onrun] \> `protected` `readonly` **\_onRun**: [`OnRunEvent`](/jsdoc/nqtr/index/type-aliases/OnRunEvent)\<[`ActivityInterface`](/jsdoc/nqtr/index/interfaces/ActivityInterface)> Defined in: [src/classes/activity/ActivityStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L19) #### Inherited from [#inherited-from] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`_onRun`](/jsdoc/nqtr/index/classes/ActivityStoredClass#_onrun) *** ### 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. #### Inherited from [#inherited-from-1] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`id`](/jsdoc/nqtr/index/classes/ActivityStoredClass#id) ## Accessors [#accessors] ### dateScheduling [#datescheduling] #### Get Signature [#get-signature] \> **get** **dateScheduling**(): [`DateSchedulingInterface`](/jsdoc/nqtr/index/interfaces/DateSchedulingInterface) | `undefined` Defined in: [src/classes/activity/ActivityStoredClass.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L34) Used to schedule what date it will be added and removed. ##### Returns [#returns-1] [`DateSchedulingInterface`](/jsdoc/nqtr/index/interfaces/DateSchedulingInterface) | `undefined` #### Inherited from [#inherited-from-2] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`dateScheduling`](/jsdoc/nqtr/index/classes/ActivityStoredClass#datescheduling) *** ### disabled [#disabled] #### Get Signature [#get-signature-1] \> **get** **disabled**(): `boolean` Defined in: [src/classes/activity/ActivityBaseModel.ts:63](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L63) Whether is disabled. If it is a string, it is a Pixi'VN flag name. ##### Returns [#returns-2] `boolean` #### Set Signature [#set-signature] \> **set** **disabled**(`value`): `void` Defined in: [src/classes/activity/ActivityBaseModel.ts:70](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L70) ##### Parameters [#parameters-1] ###### value [#value] `string` | `boolean` ##### Returns [#returns-3] `void` *** ### expired [#expired] #### Get Signature [#get-signature-2] \> **get** **expired**(): `boolean` Defined in: [src/classes/activity/ActivityStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L48) Whether the activity/commitment is a deadline, so it will then be removed or hidden. It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0. ##### Returns [#returns-4] `boolean` #### Inherited from [#inherited-from-3] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`expired`](/jsdoc/nqtr/index/classes/ActivityStoredClass#expired) *** ### hidden [#hidden] #### Get Signature [#get-signature-3] \> **get** **hidden**(): `boolean` Defined in: [src/classes/activity/ActivityBaseModel.ts:78](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L78) Whether is hidden. If it is a string, it is a Pixi'VN flag name. ##### Returns [#returns-5] `boolean` #### Set Signature [#set-signature-1] \> **set** **hidden**(`value`): `void` Defined in: [src/classes/activity/ActivityBaseModel.ts:85](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L85) ##### Parameters [#parameters-2] ###### value [#value-1] `string` | `boolean` ##### Returns [#returns-6] `void` *** ### icon [#icon] #### Get Signature [#get-signature-4] \> **get** **icon**(): `string` | `undefined` Defined in: [src/classes/activity/ActivityBaseModel.ts:93](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L93) The icon of the activity. ##### Returns [#returns-7] `string` | `undefined` *** ### name [#name] #### Get Signature [#get-signature-5] \> **get** **name**(): `string` Defined in: [src/classes/activity/ActivityBaseModel.ts:52](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L52) The name of the activity. ##### Returns [#returns-8] `string` #### Set Signature [#set-signature-2] \> **set** **name**(`value`): `void` Defined in: [src/classes/activity/ActivityBaseModel.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L55) ##### Parameters [#parameters-3] ###### value [#value-2] `string` | `undefined` ##### Returns [#returns-9] `void` *** ### run [#run] #### Get Signature [#get-signature-6] \> **get** **run**(): [`OnRunAsyncFunction`](/jsdoc/nqtr/index/type-aliases/OnRunAsyncFunction) Defined in: [src/classes/activity/ActivityStoredClass.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L41) The function that is called when the activity/commitment is runned. ##### Returns [#returns-10] [`OnRunAsyncFunction`](/jsdoc/nqtr/index/type-aliases/OnRunAsyncFunction) #### Inherited from [#inherited-from-4] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`run`](/jsdoc/nqtr/index/classes/ActivityStoredClass#run) *** ### timeSlot [#timeslot] #### Get Signature [#get-signature-7] \> **get** **timeSlot**(): [`TimeSchedulingInterface`](/jsdoc/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/jsdoc/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined` Defined in: [src/classes/activity/ActivityStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L29) Time slot in which activity/commitment will be active. ##### Returns [#returns-11] [`TimeSchedulingInterface`](/jsdoc/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/jsdoc/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined` #### Inherited from [#inherited-from-5] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`timeSlot`](/jsdoc/nqtr/index/classes/ActivityStoredClass#timeslot) ## Methods [#methods] ### addTempHistoryItem() [#addtemphistoryitem] \> `protected` **addTempHistoryItem**(): `void` Defined in: [src/classes/activity/ActivityStoredClass.ts:38](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L38) #### Returns [#returns-12] `void` #### Inherited from [#inherited-from-6] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`addTempHistoryItem`](/jsdoc/nqtr/index/classes/ActivityStoredClass#addtemphistoryitem) *** ### 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-4] ##### propertyName [#propertyname] `string` The name of the property to get. ##### idToUse? [#idtouse] `string` The id of the instance to get the property. #### Returns [#returns-13] `T` | `undefined` The value of the property. If the property is not found, returns undefined. #### Default [#default] ```ts this.id ``` #### Inherited from [#inherited-from-7] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`getStorageProperty`](/jsdoc/nqtr/index/classes/ActivityStoredClass#getstorageproperty) *** ### isActive() [#isactive] \> **isActive**(`options?`): `boolean` Defined in: [src/classes/activity/ActivityStoredClass.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L55) Whether the activity/commitment is active, so it will be shown in the routine and can be runned. #### Parameters [#parameters-5] ##### options? [#options] [`ActiveScheduling`](/jsdoc/nqtr/index/interfaces/ActiveScheduling) = `{}` The options to check if the activity/commitment is active. #### Returns [#returns-14] `boolean` #### Inherited from [#inherited-from-8] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`isActive`](/jsdoc/nqtr/index/classes/ActivityStoredClass#isactive) *** ### migrateOldStorage() [#migrateoldstorage] \> `protected` **migrateOldStorage**(`oldCategoryId?`): `void` Defined in: node\_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37 #### Parameters [#parameters-6] ##### oldCategoryId? [#oldcategoryid] `string` #### Returns [#returns-15] `void` #### Inherited from [#inherited-from-9] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`migrateOldStorage`](/jsdoc/nqtr/index/classes/ActivityStoredClass#migrateoldstorage) *** ### 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-3] `StorageElementType` The value to set. If is undefined, the property will be removed from the storage. #### Returns [#returns-16] `void` #### Inherited from [#inherited-from-10] [`ActivityStoredClass`](/jsdoc/nqtr/index/classes/ActivityStoredClass).[`setStorageProperty`](/jsdoc/nqtr/index/classes/ActivityStoredClass#setstorageproperty)