Template:Infobox ScriptAPI function/doc

[清除缓存]

这是文档页面，它应该被放置到Template:Infobox ScriptAPI function，查看Template:Documentation以获取更多信息。

doc

脚本API函数

API

脚本API

适用语言

JavaScript

类型

函数

受限只读模式

否

参数数量

0

返回值类型

Void

所属模块

[[Manual:|]]

支持模块版本

?

加入版本

?

{{infobox ScriptAPI function}}应当被放在条目顶端，给予读者关于条目的基本信息。

模板参数

该模板是脚本API函数的Infobox

模板参数

此模板首选参数换行的代码块格式。

参数		描述	类型	状态
标题	title	Infobox的标题，不填写时默认继承页面标题 默认值 {{PAGENAME}}	页面名称	可选
静态方法	static	该函数是否为静态方法 默认值 false	布尔	可选
内部函数	internal	该函数是否为内部函数 默认值 false	布尔	可选
类型	type	该函数的类型 默认值 function	字符串	可选
受限只读模式	readonlymode	该函数是否受限于只读模式 默认值 否	布尔	可选
参数数量	paramnum	该函数的参数数量 默认值 0	数字	可选
最大参数数量	parammax	该函数的最大参数数量 默认值 {{{parammin}}}	数字	可选
最小参数数量	parammin	该函数的最小参数数量 默认值 {{{parammax}}}	数字	可选
参数类型	param	该函数的参数类型，每两个参数类型之间用分号隔开	字符串	可选
启用参数类型子信息框	paramsubbox	是否启用参数类型子信息框 默认值 false	布尔	可选
参数<名称>类型	param-<name>	参数的类型，每两个参数类型之间用分号隔开。需先启用参数类型子信息框	字符串	可选
返回值类型	return	该函数的返回值类型，每两个返回值类型之间用分号隔开 默认值 Void	字符串	可选
所属模块	module	该函数所属模块，可填写c、sa、se、sg、sn、su、s、va	字符串	可选
所属类	class	该函数所属类	字符串	可选
支持模块版本	versions	支持该类的模块版本，每两个版本之间用分号隔开	字符串	必需
加入版本	added	加入版本	字符串	必需
弃用版本	deprecated	弃用版本	字符串	可选
移除版本	removed	移除版本	字符串	可选
所需实验性玩法	experiment	组件所依赖的实验性玩法，可填{{Experiment}}的参数，每两个参数之间用分号隔开	字符串	可选

示例

SomeFunction

脚本API函数

API

脚本API

适用语言

JavaScript

类型

静态方法

受限只读模式

否

参数数量

1 ~ 3

参数类型

参数 1

String | Number

参数 2

Object

参数 3

Boolean

返回值类型

Number

所属模块

@minecraft/server

所属类

SomeClass

支持模块版本

≥ 1.0.0

加入版本

1.19.20.20

所需实验性玩法

测试版API

{{infobox ScriptAPI function
| title = SomeFunction
| static = true
| type = method
| parammax = 3
| parammin = 1
| paramsubbox = true
| param-1 = String;Number
| param-2 = Object
| param-3 = Boolean
| return = Number
| module = server
| class = SomeClass
| versions = ≥ 1.0.0
| added = 1.19.20.20
| experiment = gtst
}}

参见

• {{infobox}}