Class SchedulePlan

Index

Methods

create addBlock removeBlock updateBlock hasBlock getBlock blockCount current allActive blocksFor allCurrent list clear dispose

Methods

`Static`create

create(opts?: SchedulePlanOptions): SchedulePlan
Parameters
- opts: SchedulePlanOptions = {}
Returns SchedulePlan
- Defined in runtime/schedule-plan.ts:102

addBlock

addBlock(block: ScheduleBlock): boolean
Parameters
- block: ScheduleBlock
Returns boolean
- Defined in runtime/schedule-plan.ts:108

removeBlock

removeBlock(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/schedule-plan.ts:149

updateBlock

updateBlock(id: string, partial: Partial<ScheduleBlock>): boolean
Parameters
- id: string
- partial: Partial<ScheduleBlock>
Returns boolean
- Defined in runtime/schedule-plan.ts:154

hasBlock

hasBlock(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/schedule-plan.ts:190

getBlock

getBlock(id: string): ScheduleBlock | null
Parameters
- id: string
Returns ScheduleBlock | null
- Defined in runtime/schedule-plan.ts:194

blockCount

blockCount(): number
Returns number
- Defined in runtime/schedule-plan.ts:199

current

current(
characterId: string,
ctx: ScheduleQueryContext,
): ScheduleActiveBlock | null
Parameters
- characterId: string
- ctx: ScheduleQueryContext
Returns ScheduleActiveBlock | null
- Defined in runtime/schedule-plan.ts:205

allActive

allActive(characterId: string, ctx: ScheduleQueryContext): ScheduleActiveBlock[]
Parameters
- characterId: string
- ctx: ScheduleQueryContext
Returns ScheduleActiveBlock[]
- Defined in runtime/schedule-plan.ts:231

blocksFor

blocksFor(characterId: string): ScheduleBlock[]
Parameters
- characterId: string
Returns ScheduleBlock[]
- Defined in runtime/schedule-plan.ts:248

allCurrent

allCurrent(
ctx: ScheduleQueryContext,
): Record<string, ScheduleActiveBlock | null>
Parameters
- ctx: ScheduleQueryContext
Returns Record<string, ScheduleActiveBlock | null>
- Defined in runtime/schedule-plan.ts:261

list

list(): ScheduleBlock[]
Returns ScheduleBlock[]
- Defined in runtime/schedule-plan.ts:278

clear

clear(): void
Returns void
- Defined in runtime/schedule-plan.ts:289

dispose

dispose(): void
Returns void
- Defined in runtime/schedule-plan.ts:295