EasyBox3Lib~ Menu

菜单

Constructor

创建一个Menu

Parameters:
NameTypeAttributesDescription
titlestring

菜单的标题,同时也作为父菜单选项的标题

contentstring<repeatable>

菜单正文内容,可以输入多个值,显示时用\n分隔

Members

title :string

菜单的标题,同时也作为父菜单选项的标题

Type:
  • string

content :Array.<string>

菜单的标题,同时也作为父菜单选项的标题

Type:
  • Array.<string>

options :Array.<Menu>

该菜单的选项

Type:
  • Array.<Menu>

previousLevelMenu :Menu|undefined

该菜单的父菜单。如果没有,为undefined

Type:
  • Menu | undefined

handler

事件监听器

title :string

菜单的标题,同时也作为父菜单选项的标题

Type:
  • string

content :Array.<string>

菜单的标题,同时也作为父菜单选项的标题

Type:
  • Array.<string>

options :Array.<Menu>

该菜单的选项

Type:
  • Array.<Menu>

previousLevelMenu :Menu|undefined

该菜单的父菜单。如果没有,为undefined

Type:
  • Menu | undefined

handler

事件监听器

Methods

addSubmenu(submenu) → {Menu}

添加子菜单
返回该菜单本身

Parameters:
NameTypeDescription
submenuMenu | Array.<Menu>

要添加的子菜单

Returns:
Type: 
Menu

(async) open(entity) → {boolean}

打开该菜单
如果没有任何子菜单,则直接调用this.handler.onOpen,并返回true
如果关闭该菜单,则尝试打开上一级菜单

Parameters:
NameTypeDescription
entityBox3PlayerEntity

要打开该菜单的玩家

Returns:

是否完成了该菜单。如果关闭了该菜单,返回false;否则返回true

Type: 
boolean

onOpen(handler) → {Menu}

当该菜单被打开时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被打开时执行的操作。

Returns:

该菜单本身

Type: 
Menu

onClose(handler) → {Menu}

当该菜单被关闭时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被关闭时执行的操作。

Returns:

该菜单本身

Type: 
Menu

addSubmenu(submenu) → {Menu}

添加子菜单
返回该菜单本身

Parameters:
NameTypeDescription
submenuMenu | Array.<Menu>

要添加的子菜单

Returns:
Type: 
Menu

(async) open(entity) → {boolean}

打开该菜单
如果没有任何子菜单,则直接调用this.handler.onOpen,并返回true
如果关闭该菜单,则尝试打开上一级菜单

Parameters:
NameTypeDescription
entityBox3PlayerEntity

要打开该菜单的玩家

Returns:

是否完成了该菜单。如果关闭了该菜单,返回false;否则返回true

Type: 
boolean

onOpen(handler) → {Menu}

当该菜单被打开时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被打开时执行的操作。

Returns:

该菜单本身

Type: 
Menu

onClose(handler) → {Menu}

当该菜单被关闭时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被关闭时执行的操作。

Returns:

该菜单本身

Type: 
Menu

EasyBox3Lib~ Menu

菜单

Constructor

创建一个Menu

Parameters:
NameTypeAttributesDescription
titlestring

菜单的标题,同时也作为父菜单选项的标题

contentstring<repeatable>

菜单正文内容,可以输入多个值,显示时用\n分隔

Members

title :string

菜单的标题,同时也作为父菜单选项的标题

Type:
  • string

content :Array.<string>

菜单的标题,同时也作为父菜单选项的标题

Type:
  • Array.<string>

options :Array.<Menu>

该菜单的选项

Type:
  • Array.<Menu>

previousLevelMenu :Menu|undefined

该菜单的父菜单。如果没有,为undefined

Type:
  • Menu | undefined

handler

事件监听器

title :string

菜单的标题,同时也作为父菜单选项的标题

Type:
  • string

content :Array.<string>

菜单的标题,同时也作为父菜单选项的标题

Type:
  • Array.<string>

options :Array.<Menu>

该菜单的选项

Type:
  • Array.<Menu>

previousLevelMenu :Menu|undefined

该菜单的父菜单。如果没有,为undefined

Type:
  • Menu | undefined

handler

事件监听器

Methods

addSubmenu(submenu) → {Menu}

添加子菜单
返回该菜单本身

Parameters:
NameTypeDescription
submenuMenu | Array.<Menu>

要添加的子菜单

Returns:
Type: 
Menu

(async) open(entity) → {boolean}

打开该菜单
如果没有任何子菜单,则直接调用this.handler.onOpen,并返回true
如果关闭该菜单,则尝试打开上一级菜单

Parameters:
NameTypeDescription
entityBox3PlayerEntity

要打开该菜单的玩家

Returns:

是否完成了该菜单。如果关闭了该菜单,返回false;否则返回true

Type: 
boolean

onOpen(handler) → {Menu}

当该菜单被打开时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被打开时执行的操作。

Returns:

该菜单本身

Type: 
Menu

onClose(handler) → {Menu}

当该菜单被关闭时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被关闭时执行的操作。

Returns:

该菜单本身

Type: 
Menu

addSubmenu(submenu) → {Menu}

添加子菜单
返回该菜单本身

Parameters:
NameTypeDescription
submenuMenu | Array.<Menu>

要添加的子菜单

Returns:
Type: 
Menu

(async) open(entity) → {boolean}

打开该菜单
如果没有任何子菜单,则直接调用this.handler.onOpen,并返回true
如果关闭该菜单,则尝试打开上一级菜单

Parameters:
NameTypeDescription
entityBox3PlayerEntity

要打开该菜单的玩家

Returns:

是否完成了该菜单。如果关闭了该菜单,返回false;否则返回true

Type: 
boolean

onOpen(handler) → {Menu}

当该菜单被打开时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被打开时执行的操作。

Returns:

该菜单本身

Type: 
Menu

onClose(handler) → {Menu}

当该菜单被关闭时执行的操作

Parameters:
NameTypeDescription
handlerdialogCallBack

当该菜单被关闭时执行的操作。

Returns:

该菜单本身

Type: 
Menu