Class TaskGroup

Hierarchy

FormLike
- TaskGroup

Index

Constructors

Properties

description id name options

Methods

display getStatus giveAward hasOwnedAward isAvailable isVisible jumpTo lockedDisplay ownAward quit

Constructors

constructor

new TaskGroup(
    id: string,
    name: TextProvider,
    description: TextProvider,
    options: TaskGroupOptions,
): TaskGroup
Parameters
- id: string
- name: TextProvider
- description: TextProvider
- options: TaskGroupOptions
Returns TaskGroup
Overrides FormLike.constructor
- Defined in packages/task/src/api/TaskGroup.ts:12

Properties

description

description: TextProvider

`Readonly`id

id: string

name

name: TextProvider

options

options: TaskGroupOptions

Methods

display

display(player: Player, backTo: FormLike[]): void
向玩家展示表单
Parameters
- player: Player
  要展示表单的玩家
- backTo: FormLike[]
  玩家关闭表单后返回的表单，用于统一实现返回逻辑
  
  这是一个FormLike数组，在实现返回逻辑时应当将数组的第一个元素设置为应返回的表单
  
  将要跳转到其他表单后，应当将当前表单添加到数组的头部；即backTo.unshift(this)
  
  返回后，应当将去掉了第一个元素的数组传递给下个display函数
  
  当backTo为空时，返回逻辑结束
Returns void
Overrides FormLike.display
- Defined in packages/task/src/api/TaskGroup.ts:20

getStatus

getStatus(player: Player): TaskStatus
Parameters
- player: Player
Returns TaskStatus
- Defined in packages/task/src/api/TaskGroup.ts:68

`Protected`giveAward

giveAward(player: Player): void
Parameters
- player: Player
Returns void
- Defined in packages/task/src/api/TaskGroup.ts:99

hasOwnedAward

hasOwnedAward(player: Player): boolean
Parameters
- player: Player
Returns boolean
- Defined in packages/task/src/api/TaskGroup.ts:81

isAvailable

isAvailable(player: Player): boolean
Parameters
- player: Player
Returns boolean
- Defined in packages/task/src/api/TaskGroup.ts:61

isVisible

isVisible(player: Player): boolean
Parameters
- player: Player
Returns boolean
- Defined in packages/task/src/api/TaskGroup.ts:56

`Protected`jumpTo

jumpTo(player: Player, form: FormLike, backTo: readonly FormLike[]): void
统一的表单跳转方法，子类跳转新表单时请调用此方法
Parameters
- player: Player
  要跳转表单的玩家
- form: FormLike
  要跳转到的目标表单实例
- backTo: readonly FormLike[]
  当前的只读返回栈，直接透传display方法的backTo参数即可
Returns void
Inherited from FormLike.jumpTo
- Defined in node_modules/.pnpm/@occultus+core@1.1.0_@minecraft+server@2.4.0_@minecraft+common@1.2.0_@minecraft+vanilla-data@1.21.131_/node_modules/@occultus/core/src/api/base/FormLike.ts:69

`Protected`lockedDisplay

lockedDisplay(player: Player, backTo: FormLike[]): void
Parameters
- player: Player
- backTo: FormLike[]
Returns void
- Defined in packages/task/src/api/TaskGroup.ts:87

ownAward

ownAward(player: Player): void
Parameters
- player: Player
Returns void
- Defined in packages/task/src/api/TaskGroup.ts:84

quit

quit(player: Player, backTo: readonly FormLike[]): void
处理表单关闭后的返回逻辑，跳转到上一级表单
Parameters
- player: Player
  要处理返回逻辑的玩家
- backTo: readonly FormLike[]
  只读的表单返回栈，避免原数组被篡改
Returns void
Inherited from FormLike.quit
- Defined in node_modules/.pnpm/@occultus+core@1.1.0_@minecraft+server@2.4.0_@minecraft+common@1.2.0_@minecraft+vanilla-data@1.21.131_/node_modules/@occultus/core/src/api/base/FormLike.ts:55