# Interface: CommitmentProps (/nqtr/index/interfaces/CommitmentProps)



Defined in: [src/interface/activity/CommitmentProps.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L6)

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `readonly` `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/CommitmentProps.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L19)

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

***

### disabled? [#disabled]

\> `optional` **disabled?**: `string` | `boolean`

Defined in: [src/interface/activity/CommitmentProps.ts:42](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L42)

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 [#default]

```ts
false
```

***

### executionType? [#executiontype]

\> `optional` **executionType?**: [`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

Defined in: [src/interface/activity/CommitmentProps.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L29)

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 [#default-1]

```ts
"interaction"
```

***

### hidden? [#hidden]

\> `optional` **hidden?**: `string` | `boolean`

Defined in: [src/interface/activity/CommitmentProps.ts:47](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L47)

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

#### Default [#default-2]

```ts
false
```

***

### icon? [#icon]

\> `optional` **icon?**: `string`

Defined in: [src/interface/activity/CommitmentProps.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L51)

The icon of the commitment.

***

### image? [#image]

\> `optional` **image?**: `string`

Defined in: [src/interface/activity/CommitmentProps.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L23)

The image ofthe Commitment.

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/activity/CommitmentProps.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L11)

The name

#### Default [#default-3]

```ts
""
```

***

### onRun? [#onrun]

\> `optional` **onRun?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)>

Defined in: [src/interface/activity/CommitmentProps.ts:36](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L36)

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

#### Param [#param]

**commitment**

#### Returns [#returns]

#### Default [#default-4]

```ts
undefined
```

***

### priority? [#priority]

\> `optional` **priority?**: `number`

Defined in: [src/interface/activity/CommitmentProps.ts:57](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L57)

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 [#default-5]

```ts
0
```

***

### timeSlot? [#timeslot]

\> `readonly` `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)

Defined in: [src/interface/activity/CommitmentProps.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L15)

Time slot in which activity/commitment will be active.