Defined in: src/classes/activity/CommitmentBaseModel.ts:22

The base model of a commitment. I suggest you extend this class to create your own commitment model. You must use the saveCommitment function to save the commitment in the registered commitments.

Example

export const miaPlay = new CommitmentBaseModel("mia_play", mia, {
    name: "Test",
    image: "https://image.jpg",
    executionType: ExecutionTypeEnum.INTERACTION,
    onRun: (commitment) => {
        // Do something
    }
})
saveCommitment(miaPlay)

Constructors

Constructor

> new CommitmentBaseModel(id, character, props): CommitmentBaseModel

Defined in: src/classes/activity/CommitmentBaseModel.ts:28

Parameters

id

string

The id of the commitment, it must be unique.

character

string | CharacterInterface | (string | CharacterInterface)[] | undefined

The character or characters that are in the commitment and so in the room.

props

CommitmentProps

The properties of the commitment.

Properties

_onRun

> protected readonly _onRun: OnRunEvent<CommitmentInterface>

Defined in: src/classes/activity/ActivityStoredClass.ts:19

characters

> readonly characters: CharacterInterface[]

Defined in: src/classes/activity/CommitmentStoredClass.ts:72

The character or characters that are in the commitment and so in the room.

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.

runOptions?

> optional runOptions?: CommitmentRunOptions

Defined in: src/classes/activity/CommitmentStoredClass.ts:111

Options for run.

Accessors

dateScheduling

Get Signature

> get dateScheduling(): DateSchedulingInterface | undefined

Defined in: src/classes/activity/ActivityStoredClass.ts:34

Used to schedule what date it will be added and removed.

Inherited from

CommitmentStoredClass.dateScheduling

disabled

Get Signature

> get disabled(): boolean

Defined in: src/classes/activity/CommitmentBaseModel.ts:82

Whether is disabled. You can also pass a Pixi'VN flag name.

Set Signature

> set disabled(value): void

Defined in: src/classes/activity/CommitmentBaseModel.ts:89

executionType

Get Signature

> get executionType(): ExecutionType

Defined in: src/classes/activity/CommitmentStoredClass.ts:74

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function. If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

Returns

ExecutionType

Set Signature

> set executionType(value): void

Defined in: src/classes/activity/CommitmentStoredClass.ts:77

Parameters

value

ExecutionType

Returns

void

Inherited from

CommitmentStoredClass.executionType

expired

Get Signature

> get expired(): boolean

Defined in: src/classes/activity/ActivityStoredClass.ts:48

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

boolean

Inherited from

CommitmentStoredClass.expired

hidden

Get Signature

> get hidden(): boolean

Defined in: src/classes/activity/CommitmentBaseModel.ts:97

Whether is hidden. You can also pass a Pixi'VN flag name.

Returns

boolean

Set Signature

> set hidden(value): void

Defined in: src/classes/activity/CommitmentBaseModel.ts:104

Parameters

value

string | boolean

Returns

void

icon

Get Signature

> get icon(): string | undefined

Defined in: src/classes/activity/CommitmentBaseModel.ts:74

The icon of the commitment.

Returns

string | undefined

image

Get Signature

> get image(): string | undefined

Defined in: src/classes/activity/CommitmentBaseModel.ts:66

The image of the commitment.

Returns

string | undefined

name

Get Signature

> get name(): string

Defined in: src/classes/activity/CommitmentBaseModel.ts:58

The name of the commitment.

Returns

string

priority

Get Signature

> get priority(): number

Defined in: src/classes/activity/CommitmentStoredClass.ts:81

The priority. The higher the number, the higher the priority. To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

Executes the commitment's onRun callback.

Time slot in which activity/commitment will be active.

Get a property from the storage.

this.id

Inherited from

CommitmentStoredClass.getStorageProperty

isActive()

> isActive(options?): boolean

Defined in: src/classes/activity/ActivityStoredClass.ts:55

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

Update a property in the storage.

Class: CommitmentBaseModel

On this page