Skip to content

Commit 4c1eb41

Browse files
committed
docs: add api version warning for new gui api
1 parent 4c8cb70 commit 4c1eb41

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

docs/apis/GuiAPI/Form.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A modal form contains a title, a text display, and two buttons.
2727
- callback : `Function`
2828
Function called after player clicks a button.
2929
- forUpdating : `Boolean`
30-
(Optional parameter) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
30+
(Optional parameter, added in 0.11.0) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
3131
- Return value: The ID of the sent form.
3232
- Return value type: `Integer`
3333
- If the return value is `Null`, it means the sending failed.
@@ -65,7 +65,7 @@ section to better accomplish this task.
6565
- callback : `Function`
6666
The function called after the player clicks a button.
6767
- forUpdating : `Boolean`
68-
(Optional parameter) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
68+
(Optional parameter, added in 0.11.0) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
6969
- Return value: The sent form ID.
7070
- Return value type: `Integer`
7171
- If the return value is `Null`, it means the sending failed.
@@ -103,7 +103,7 @@ next section to better accomplish this task.
103103
- callback : `Function`
104104
Callback function to be called after the player submits the form.
105105
- forUpdating : `Boolean`
106-
(Optional parameter) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
106+
(Optional parameter, added in 0.11.0) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
107107
- Return value: The sent form ID.
108108
- Return value type: `Integer`
109109
- If the return value is Null, it means the sending failed.

docs/apis/GuiAPI/Form.zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
- callback : `Function`
2727
玩家点击按钮之后被调用的回调函数。
2828
- forUpdating : `Boolean`
29-
(可选参数)是否为表单更新,默认值为false,即非表单更新
29+
(可选参数,在0.11.0中加入)是否为表单更新,默认值为false,即非表单更新
3030
- 返回值:发送的表单ID
3131
- 返回值类型:`Integer`
3232
- 如果返回值为`Null`,则代表发送失败
@@ -62,7 +62,7 @@
6262
- callback : `Function`
6363
玩家点击按钮之后被调用的回调函数。
6464
- forUpdating : `Boolean`
65-
(可选参数)是否为表单更新,默认值为false,即非表单更新
65+
(可选参数,在0.11.0中加入)是否为表单更新,默认值为false,即非表单更新
6666
- 返回值:发送的表单ID
6767
- 返回值类型:`Integer`
6868
- 如果返回值为`Null`,则代表发送失败
@@ -99,7 +99,7 @@
9999
- callback : `Function`
100100
玩家提交表单之后被调用的回调函数。
101101
- forUpdating : `Boolean`
102-
(可选参数)是否为表单更新,默认值为false,即非表单更新
102+
(可选参数,在0.11.0中加入)是否为表单更新,默认值为false,即非表单更新
103103
- 返回值:发送的表单ID
104104
- 返回值类型:`Integer`
105105
- 如果返回值为`Null`,则代表发送失败

docs/apis/GuiAPI/FormBuilder.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ For a player object `pl`, using the function:
101101
- callback : `Function`
102102
Callback function to be called after the player interacts with the form element.
103103
- forUpdating : `Boolean`
104-
(Optional parameter) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
104+
(Optional parameter, added in 0.11.0) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
105105
- Return value: The sent form ID.
106106
- Return value type: `Integer`
107107
- If the return value is `Null`, it means the sending failed.
@@ -258,6 +258,9 @@ For a specific form object `fm`, the following functions are available:
258258

259259
#### Set the Text of the Submit Button
260260

261+
!!! warning
262+
This API is only available in 0.11.0 and later versions.
263+
261264
`fm.setSubmitButton(text)`
262265

263266
- Parameters:
@@ -283,7 +286,7 @@ For a player object `pl`, using the function:
283286
- callback : `Function`
284287
Callback function to be called after the player submits the form.
285288
- forUpdating : `Boolean`
286-
(Optional parameter) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
289+
(Optional parameter, added in 0.11.0) Whether the form is sent for updating. The default value is false, meaning it is not for form updating.
287290
- Return value: The sent form ID.
288291
- Return value type: `Integer`
289292
- If the return value is `Null`, it means the sending failed.

docs/apis/GuiAPI/FormBuilder.zh.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
- callback : `Function`
102102
玩家与表单元素互动之后被调用的回调函数。
103103
- forUpdating : `Boolean`
104-
(可选参数)是否为表单更新,默认值为false,即非表单更新
104+
(可选参数,在0.11.0中加入)是否为表单更新,默认值为false,即非表单更新
105105
- 返回值:发送的表单ID
106106
- 返回值类型:`Integer`
107107
- 如果返回值为`Null`,则代表发送失败
@@ -257,6 +257,9 @@ reason可能会是`null`.
257257

258258
#### 设置提交按钮的文本
259259

260+
!!! warning
261+
此API仅在0.11.0及更高版本中可用。
262+
260263
`fm.setSubmitButton(text)`
261264

262265
- 参数:
@@ -280,7 +283,7 @@ reason可能会是`null`.
280283
- callback : `Function`
281284
玩家提交表单之后被调用的回调函数。
282285
- forUpdating : `Boolean`
283-
(可选参数)是否为表单更新,默认值为false,即非表单更新
286+
(可选参数,在0.11.0中加入)是否为表单更新,默认值为false,即非表单更新
284287
- 返回值:发送的表单ID
285288
- 返回值类型:`Integer`
286289
- 如果返回值为`Null`,则代表发送失败

0 commit comments

Comments
 (0)