Interface: CommitmentProps

Defined in: src/interface/activity/CommitmentProps.ts:6

Properties

dateScheduling?

> readonly optional dateScheduling?: DateSchedulingInterface

Defined in: src/interface/activity/CommitmentProps.ts:19

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

disabled?

> optional disabled?: string | boolean

Defined in: src/interface/activity/CommitmentProps.ts:42

Whether is disabled. You can also pass a Pixi'VN flag name. If it is disabled this commitment will not be taken into consideration. So the characters will not be in the room, but will be busy with other commitments.

Default

false

executionType?

> optional executionType?: ExecutionType

Defined in: src/interface/activity/CommitmentProps.ts:29

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.

Default

"interaction"

hidden?

> optional hidden?: string | boolean

Defined in: src/interface/activity/CommitmentProps.ts:47

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

Default

false

icon?

> optional icon?: string

Defined in: src/interface/activity/CommitmentProps.ts:51

The icon of the commitment.

image?

> optional image?: string

Defined in: src/interface/activity/CommitmentProps.ts:23

The image ofthe Commitment.

name?

> optional name?: string

Defined in: src/interface/activity/CommitmentProps.ts:11

The name

Default

""

onRun?

> optional onRun?: OnRunEvent<CommitmentInterface>

Defined in: src/interface/activity/CommitmentProps.ts:36

Is a function that is called when the player interacts with the character.

Param

commitment

Returns

Default

undefined

priority?

> optional priority?: number

Defined in: src/interface/activity/CommitmentProps.ts:57

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.

Default

0

timeSlot?

> readonly optional timeSlot?: TimeSchedulingInterface

Defined in: src/interface/activity/CommitmentProps.ts:15

Time slot in which activity/commitment will be active.