@drincs/nqtr
Version:
A complete system introducing the concepts of location, time and event, producing the framework of a not-quite-point-and-click adventure game.
49 lines (47 loc) • 1.58 kB
TypeScript
interface ActivityProps {
/**
* The name
* @default ""
*/
name?: string;
/**
* The hour when the activity starts. If the activity is not started yet, it will be hidden.
* If you set 3, the activity will be hidden into hours 1 and 2, and will be shown from hour 3.
* @default timeTracker.minDayHours
*/
fromHour?: number;
/**
* The hour when the activity ends. If the activity is ended yet, it will be hidden.
* If you set 3, the activity will be shown into hours 1 and 2 and will be hidden from hour 3.
* @default timeTracker.maxDayHours + 1
*/
toHour?: number;
/**
* The day when the activity starts. If the activity is not started yet, it will be hidden.
* If you set 3, the activity will be hidden into days 1 and 2, and will be shown from day 3.
* @default undefined
*/
fromDay?: number;
/**
* The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
* If you set 3, the activity will be shown into days 1 and 2 and will be deleted or hidden from day 3.
* @default undefined
*/
toDay?: number;
/**
* Whether is disabled. You can also pass a Pixi'VN flag name.
* @default false
*/
disabled?: boolean | string;
/**
* Whether is hidden. You can also pass a Pixi'VN flag name.
* @default false
*/
hidden?: boolean | string;
/**
* The icon of the activity.
* @default undefined
*/
renderIcon?: string;
}
export type { ActivityProps as default };