Class Tutorial

表示教程的类，管理这个教程的解锁状态、显示逻辑和回调事件

Hierarchy

FormLike
- Tutorial

Index

Constructors

Properties

body config id name

Methods

display isAvailable jumpTo onUnlock quit unlock parse

Constructors

constructor

new Tutorial(
    id: string,
    name: TextProvider,
    body: TextProvider | TutorialSet[],
    config: TutorialConfig,
): Tutorial
Parameters
- id: string
  教程的唯一标识符
- name: TextProvider
  教程的名称
- body: TextProvider | TutorialSet[]
  教程的内容
- config: TutorialConfig
  教程的配置对象
Returns Tutorial
Overrides FormLike.constructor
- Defined in packages/tutorial/src/api/Tutorial.ts:46

Properties

body

body: TextProvider | TutorialSet[]

教程的内容

config

config: TutorialConfig

教程的配置对象

`Readonly`id

id: string

教程的唯一标识符

name

name: TextProvider

教程的名称

Methods

display

display(player: Player, backTo: FormLike[]): void
向玩家显示教程内容
Parameters
- player: Player
  要显示教程的玩家
- backTo: FormLike[]
  可选的返回对象，用于在教程结束后返回上级界面
Returns void
Overrides FormLike.display
- Defined in packages/tutorial/src/api/Tutorial.ts:89

isAvailable

isAvailable(player: Player): boolean
检查教程对指定玩家是否可用
Parameters
- player: Player
  要检查可用性的玩家对象
Returns boolean
教程是否可用
- Defined in packages/tutorial/src/api/Tutorial.ts:60

`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

onUnlock

onUnlock(callback: (player: Player) => void): void
设置教程解锁时的回调函数
Parameters
- callback: (player: Player) => void
  解锁时执行的回调函数，接收玩家对象作为参数
Returns void
- Defined in packages/tutorial/src/api/Tutorial.ts:105

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

unlock

unlock(player: Player): void
解锁教程
Parameters
- player: Player
  要为其解锁教程的玩家
Returns void
- Defined in packages/tutorial/src/api/Tutorial.ts:70

`Static`parse

parse(raw: RawTutorialData): Tutorial | TutorialGroup
从原始数据解析教程对象
Parameters
- raw: RawTutorialData
Returns Tutorial | TutorialGroup
- Defined in packages/tutorial/src/api/Tutorial.ts:19