Class Task

Hierarchy

FormLike
- Task

Index

Constructors

Properties

description id name options

Methods

checkConditions complete display getStatus giveAwards isAvailable isVisible jumpTo lockedDisplay onComplete pushToServer quit

Constructors

constructor

new Task(
    id: string,
    name: TextProvider,
    description: TextProvider,
    options: TaskOptions,
): Task
Parameters
- id: string
  任务的唯一标识符
- name: TextProvider
  任务名称
- description: TextProvider
  任务描述
- options: TaskOptions
  任务的配置选项
Returns Task
Overrides FormLike.constructor
- Defined in packages/task/src/api/Task.ts:19

Properties

description

description: TextProvider

任务描述

`Readonly`id

id: string

任务的唯一标识符

name

name: TextProvider

任务名称

options

options: TaskOptions

任务的配置选项

Methods

`Protected`checkConditions

checkConditions(player: Player): boolean
检查玩家是否能完成任务
Parameters
- player: Player
Returns boolean
- Defined in packages/task/src/api/Task.ts:109

complete

complete(player: Player): void
Parameters
- player: Player
Returns void
- Defined in packages/task/src/api/Task.ts:121

display

display(player: Player, backTo: FormLike[]): void
向玩家展示任务
Parameters
- player: Player
  要展示任务的玩家
- backTo: FormLike[]
  关闭任务 UI 后返回的界面
Returns void
Overrides FormLike.display
- Defined in packages/task/src/api/Task.ts:32

getStatus

getStatus(player: Player): TaskStatus
获取任务状态
Parameters
- player: Player
  要获取任务状态的玩家
Returns TaskStatus
玩家的任务状态
- Defined in packages/task/src/api/Task.ts:96

`Protected`giveAwards

giveAwards(player: Player): void
向玩家给予奖励
Parameters
- player: Player
Returns void
- Defined in packages/task/src/api/Task.ts:118

isAvailable

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

isVisible

isVisible(player: Player): boolean
返回玩家是否可以在任务列表中看到该任务
Parameters
- player: Player
Returns boolean
倘若玩家可以在任务列表中看到该任务返回true，否则返回false
- Defined in packages/task/src/api/Task.ts:67

`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/Task.ts:79

onComplete

onComplete(event: (player: Player, task: Task) => void): void
Parameters
- event: (player: Player, task: Task) => void
Returns void
- Defined in packages/task/src/api/Task.ts:149

pushToServer

pushToServer(server: TaskServer): void
直接将任务上传到服务端监听器中

IMPORTANT: 除非任务使用的条件有特殊说明，否则此方法一般无用
Parameters
- server: TaskServer
Returns void
- Defined in packages/task/src/api/Task.ts:146

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