Skip to content

Commit 685f632

Browse files
Site changes [skip-ci]
1 parent 9213d14 commit 685f632

File tree

1 file changed

+84
-2
lines changed

1 file changed

+84
-2
lines changed

_data/ref/alpha/editor-lua.json

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1109,6 +1109,47 @@
11091109
"tparams": [],
11101110
"type": "FUNCTION"
11111111
},
1112+
{
1113+
"brief": "check if <code>editor.tx.reset()</code> transaction with this property won't throw an error",
1114+
"description": "Check if <code>editor.tx.reset()</code> transaction with this property won't throw an error",
1115+
"error": "",
1116+
"examples": "",
1117+
"language": "",
1118+
"members": [],
1119+
"name": "editor.can_reset",
1120+
"notes": [],
1121+
"parameters": [
1122+
{
1123+
"doc": "Either resource path (e.g. <code>\"/main/game.script\"</code>), or internal node id passed to the script by the editor",
1124+
"is_optional": "False",
1125+
"name": "node",
1126+
"types": [
1127+
"string",
1128+
"userdata"
1129+
]
1130+
},
1131+
{
1132+
"doc": "Either <code>\"path\"</code>, <code>\"text\"</code>, or a property from the Outline view (hover the label to see its editor script name)",
1133+
"is_optional": "False",
1134+
"name": "property",
1135+
"types": [
1136+
"string"
1137+
]
1138+
}
1139+
],
1140+
"replaces": "",
1141+
"returnvalues": [
1142+
{
1143+
"doc": "",
1144+
"name": "value",
1145+
"types": [
1146+
"boolean"
1147+
]
1148+
}
1149+
],
1150+
"tparams": [],
1151+
"type": "FUNCTION"
1152+
},
11121153
{
11131154
"brief": "check if <code>editor.tx.set()</code> transaction with this property won't throw an error",
11141155
"description": "Check if <code>editor.tx.set()</code> transaction with this property won't throw an error",
@@ -2044,8 +2085,8 @@
20442085
"type": "FUNCTION"
20452086
},
20462087
{
2047-
"brief": "create a transaction step that will deletes all items from node's list property when transacted with <code>editor.transact()</code>.",
2048-
"description": "Create a transaction step that will deletes all items from node's list property when transacted with <code>editor.transact()</code>.",
2088+
"brief": "create a transaction step that will remove all items from node's list property when transacted with <code>editor.transact()</code>.",
2089+
"description": "Create a transaction step that will remove all items from node's list property when transacted with <code>editor.transact()</code>.",
20492090
"error": "",
20502091
"examples": "",
20512092
"language": "",
@@ -2183,6 +2224,47 @@
21832224
"tparams": [],
21842225
"type": "FUNCTION"
21852226
},
2227+
{
2228+
"brief": "create a transaction step that will reset an overridden property to its default value when transacted with <code>editor.transact()</code>.",
2229+
"description": "Create a transaction step that will reset an overridden property to its default value when transacted with <code>editor.transact()</code>.",
2230+
"error": "",
2231+
"examples": "",
2232+
"language": "",
2233+
"members": [],
2234+
"name": "editor.tx.reset",
2235+
"notes": [],
2236+
"parameters": [
2237+
{
2238+
"doc": "Either resource path (e.g. <code>\"/main/game.script\"</code>), or internal node id passed to the script by the editor",
2239+
"is_optional": "False",
2240+
"name": "node",
2241+
"types": [
2242+
"string",
2243+
"userdata"
2244+
]
2245+
},
2246+
{
2247+
"doc": "Either <code>\"path\"</code>, <code>\"text\"</code>, or a property from the Outline view (hover the label to see its editor script name)",
2248+
"is_optional": "False",
2249+
"name": "property",
2250+
"types": [
2251+
"string"
2252+
]
2253+
}
2254+
],
2255+
"replaces": "",
2256+
"returnvalues": [
2257+
{
2258+
"doc": "A transaction step",
2259+
"name": "tx",
2260+
"types": [
2261+
"transaction_step"
2262+
]
2263+
}
2264+
],
2265+
"tparams": [],
2266+
"type": "FUNCTION"
2267+
},
21862268
{
21872269
"brief": "create transaction step that will set the node's property to a supplied value when transacted with <code>editor.transact()</code>.",
21882270
"description": "Create transaction step that will set the node's property to a supplied value when transacted with <code>editor.transact()</code>.",

0 commit comments

Comments
 (0)