Skip to content

Commit e443386

Browse files
Site changes [skip-ci]
1 parent 66f1f1a commit e443386

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

_data/ref/alpha/editor-lua.json

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1068,6 +1068,47 @@
10681068
"tparams": [],
10691069
"type": "FUNCTION"
10701070
},
1071+
{
1072+
"brief": "check if <code>editor.tx.reorder()</code> transaction with this property won't throw an error",
1073+
"description": "Check if <code>editor.tx.reorder()</code> transaction with this property won't throw an error",
1074+
"error": "",
1075+
"examples": "",
1076+
"language": "",
1077+
"members": [],
1078+
"name": "editor.can_reorder",
1079+
"notes": [],
1080+
"parameters": [
1081+
{
1082+
"doc": "Either resource path (e.g. <code>\"/main/game.script\"</code>), or internal node id passed to the script by the editor",
1083+
"is_optional": "False",
1084+
"name": "node",
1085+
"types": [
1086+
"string",
1087+
"userdata"
1088+
]
1089+
},
1090+
{
1091+
"doc": "Either <code>\"path\"</code>, <code>\"text\"</code>, or a property from the Outline view (hover the label to see its editor script name)",
1092+
"is_optional": "False",
1093+
"name": "property",
1094+
"types": [
1095+
"string"
1096+
]
1097+
}
1098+
],
1099+
"replaces": "",
1100+
"returnvalues": [
1101+
{
1102+
"doc": "",
1103+
"name": "value",
1104+
"types": [
1105+
"boolean"
1106+
]
1107+
}
1108+
],
1109+
"tparams": [],
1110+
"type": "FUNCTION"
1111+
},
10711112
{
10721113
"brief": "check if <code>editor.tx.set()</code> transaction with this property won't throw an error",
10731114
"description": "Check if <code>editor.tx.set()</code> transaction with this property won't throw an error",
@@ -2093,6 +2134,55 @@
20932134
"tparams": [],
20942135
"type": "FUNCTION"
20952136
},
2137+
{
2138+
"brief": "create a transaction step that reorders child nodes in a node list defined by the property if supported (see <code>editor.can_reorder()</code>)",
2139+
"description": "Create a transaction step that reorders child nodes in a node list defined by the property if supported (see <code>editor.can_reorder()</code>)",
2140+
"error": "",
2141+
"examples": "",
2142+
"language": "",
2143+
"members": [],
2144+
"name": "editor.tx.reorder",
2145+
"notes": [],
2146+
"parameters": [
2147+
{
2148+
"doc": "Either resource path (e.g. <code>\"/main/game.script\"</code>), or internal node id passed to the script by the editor",
2149+
"is_optional": "False",
2150+
"name": "node",
2151+
"types": [
2152+
"string",
2153+
"userdata"
2154+
]
2155+
},
2156+
{
2157+
"doc": "Either <code>\"path\"</code>, <code>\"text\"</code>, or a property from the Outline view (hover the label to see its editor script name)",
2158+
"is_optional": "False",
2159+
"name": "property",
2160+
"types": [
2161+
"string"
2162+
]
2163+
},
2164+
{
2165+
"doc": "array of child nodes (the same as returned by <code>editor.get(node, property)</code>) in new order",
2166+
"is_optional": "False",
2167+
"name": "child_nodes",
2168+
"types": [
2169+
"table"
2170+
]
2171+
}
2172+
],
2173+
"replaces": "",
2174+
"returnvalues": [
2175+
{
2176+
"doc": "A transaction step",
2177+
"name": "tx",
2178+
"types": [
2179+
"transaction_step"
2180+
]
2181+
}
2182+
],
2183+
"tparams": [],
2184+
"type": "FUNCTION"
2185+
},
20962186
{
20972187
"brief": "create transaction step that will set the node's property to a supplied value when transacted with <code>editor.transact()</code>.",
20982188
"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)