Skip to content

Extension update: [ArrayTools] add Filter, SortStructuresByField, CopyVariable #2004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BogdanLyopa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Extension update: [ArrayTools] add Filter, SortStructuresByField, CopyVariable #2004

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 256 additions & 0 deletions extensions/reviewed/ArrayTools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,44 @@
],
"objectGroups": []
},
{
"description": "Copies a variable (structure or array) completely with all nested fields. Creates a real deep copy without any links.",
"fullName": "Copy variable",
"functionType": "Action",
"group": "Scene variables/Array creation",
"name": "CopyVariable",
"sentence": "Copy variable _PARAM1_ to _PARAM2_",
"events": [
{
"type": "BuiltinCommonInstructions::JsCode",
"inlineCode": [
"/** @type {gdjs.Variable} */",
"const sourceVariable = eventsFunctionContext.getArgument(\"SourceVariable\");",
"const targetVariable = eventsFunctionContext.getArgument(\"TargetVariable\");",
"if (targetVariable.getChildrenCount() !== 0) {",
" targetVariable.clearChildren();",
"}",
"gdjs.Variable.copy(sourceVariable, targetVariable, true);"
],
"parameterObjects": "",
"useStrict": true,
"eventsSheetExpanded": false
}
],
"parameters": [
{
"description": "Source variable (structure or array) to copy from",
"name": "SourceVariable",
"type": "variable"
},
{
"description": "Target variable (structure or array) to copy to",
"name": "TargetVariable",
"type": "variable"
}
],
"objectGroups": []
},
{
"description": "Appends a copy of all variables of one array to another array.",
"fullName": "Append all variable to another array",
Expand Down Expand Up @@ -823,6 +861,153 @@
],
"objectGroups": []
},
{
"description": "Filters an array based on a comparison condition. Can filter arrays of numbers, strings, or structures. If OutputArray is not specified, the input array is mutated.",
"fullName": "Filter array",
"functionType": "Action",
"group": "Scene variables/Array manipulation",
"name": "Filter",
"sentence": "Filter array _PARAM1_ where _PARAM2_ _PARAM3_ _PARAM4_ into _PARAM5_",
"events": [
{
"type": "BuiltinCommonInstructions::JsCode",
"inlineCode": [
"/** @type {gdjs.Variable} */",
"const sourceArray = eventsFunctionContext.getArgument(\"SourceArray\");",
"const outputArray = eventsFunctionContext.getArgument(\"OutputArray\");",
"const fieldName = eventsFunctionContext.getArgument(\"FieldPath\");",
"const operator = eventsFunctionContext.getArgument(\"Operator\");",
"const rawValue = eventsFunctionContext.getArgument(\"Value\");",
"",
"sourceArray.castTo(\"array\");",
"",
"const fieldPath = fieldName ? fieldName.split(\".\") : null;",
"",
"const getField = (variable) => {",
" if (!fieldPath) return variable;",
"",
" let current = variable;",
" for (const part of fieldPath) {",
" if (!current.isStructure() || !current.hasChild(part)) return null;",
" current = current.getChild(part);",
" }",
" return current || null;",
"};",
"",
"const OPERATORS = new Map([",
" [\"==\", (a, b) => a === b],",
" [\"!=\", (a, b) => a !== b],",
" [\">\", (a, b) => a > b],",
" [\"<\", (a, b) => a < b],",
" [\">=\", (a, b) => a >= b],",
" [\"<=\", (a, b) => a <= b],",
"]);",
"",
"",
"const parsedValue = (() => {",
" const v = rawValue.trim();",
"",
" if (!isNaN(v) && v !== \"\") {",
" return { type: \"number\", value: Number(v) };",
" }",
"",
" if (v === \"true\" || v === \"false\") {",
" return { type: \"boolean\", value: v === \"true\" };",
" }",
"",
" if (v.startsWith(\"/\") && v.endsWith(\"/\") && v.length > 2) {",
" try {",
" return {",
" type: \"regex\",",
" value: new RegExp(v.slice(1, -1)),",
" };",
" } catch (_) { }",
" }",
"",
" return { type: \"string\", value: rawValue };",
"})();",
"",
"const compare = (variable) => {",
" if (!variable) return false;",
"",
" switch (parsedValue.type) {",
" case \"number\":",
" return OPERATORS.get(operator)(variable.getAsNumber(), parsedValue.value);",
"",
" case \"boolean\":",
" return OPERATORS.get(operator)(variable.getAsBool(), parsedValue.value);",
"",
" case \"regex\": {",
" if (operator === \"==\") {",
" return parsedValue.value.test(variable.getAsString());",
" } else {",
" return !parsedValue.value.test(variable.getAsString());",
" }",
" }",
"",
" case \"string\":",
" return OPERATORS.get(operator)(variable.getAsString(), parsedValue.value);",
" default:",
" return false;",
" }",
"",
" return false;",
"};",
"",
"const filtered = sourceArray.getAllChildrenArray().filter((variable) =>",
" compare(getField(variable))",
");",
"",
"const resultArray = outputArray.getValue() ? outputArray : sourceArray;",
"",
"resultArray.castTo(\"array\");",
"resultArray.clearChildren();",
"for (const child of filtered) {",
" resultArray.pushVariableCopy(child);",
"}",
""
],
"parameterObjects": "",
"useStrict": true,
"eventsSheetExpanded": false
}
],
"parameters": [
{
"description": "Array to filter",
"name": "SourceArray",
"type": "variable"
},
{
"description": "Field name or path to check for structures (supports nested fields like \"player.score\")",
"longDescription": "Leave empty to compare the array element directly. For structures, use dot notation to access nested fields (e.g., \"player.score\").",
"name": "FieldPath",
"optional": true,
"type": "string"
},
{
"description": "Comparison operator",
"name": "Operator",
"supplementaryInformation": "[\"==\",\"!=\",\">\",\"<\",\">=\",\"<=\"]",
"type": "stringWithSelector"
},
{
"description": "Value to compare against (can be regex like /pattern/, number, boolean, or text)",
"longDescription": "For regex matching, use format /pattern/ (e.g., /^test/). For numbers, enter the number. For booleans, use \"true\" or \"false\". For strings, enter the text.",
"name": "Value",
"type": "string"
},
{
"description": "Output array (leave empty to mutate input array)",
"longDescription": "If specified, filtered results will be stored in this array. If left empty, the source array will be modified in place.",
"name": "OutputArray",
"optional": true,
"type": "variable"
}
],
"objectGroups": []
},

{
"description": "Fill an element with a number.",
"fullName": "Fill array with number",
Expand Down Expand Up @@ -1452,6 +1637,77 @@
],
"objectGroups": []
},
{
"description": "Sorts an array of structures by a specified field or path. Automatically detects if the value is a number or string and sorts accordingly.",
"fullName": "Sort structures by field",
"functionType": "Action",
"group": "Scene variables/Array manipulation",
"name": "SortStructuresByField",
"sentence": "Sort array _PARAM1_ by field _PARAM2_",
"events": [
{
"type": "BuiltinCommonInstructions::JsCode",
"inlineCode": [
"/** @type {gdjs.Variable} */",
"const array = eventsFunctionContext.getArgument(\"Array\");",
"const fieldName = eventsFunctionContext.getArgument(\"FieldPath\");",
"",
"array.castTo(\"array\");",
"",
"const fieldPath = fieldName ? fieldName.split(\".\") : null;",
"",
"const getValue = (variable) => {",
" let current = variable;",
"",
" if (fieldPath) {",
" for (const part of fieldPath) {",
" if (!current.isStructure() || !current.hasChild(part)) return null;",
" current = current.getChild(part);",
" if (!current) return null;",
" }",
" }",
"",
" const type = current.getType();",
" return type === \"number\"",
" ? current.getAsNumber()",
" : current.getAsString();",
"};",
"",
"array.getAllChildrenArray().sort((a, b) => {",
" const av = getValue(a);",
" const bv = getValue(b);",
"",
" const aIsNum = typeof av === \"number\";",
" const bIsNum = typeof bv === \"number\";",
"",
" if (aIsNum !== bIsNum) return aIsNum ? -1 : 1;",
" if (av < bv) return -1;",
" if (av > bv) return 1;",
" return 0;",
"});",
""
],
"parameterObjects": "",
"useStrict": true,
"eventsSheetExpanded": false
}
],
"parameters": [
{
"description": "Array of structures to sort",
"name": "Array",
"type": "variable"
},
{
"description": "Field name or path to sort by (supports nested fields like \"player.score\")",
"longDescription": "For structures, use dot notation to access nested fields (e.g., \"player.score\").",
"name": "FieldPath",
"type": "string"
}
],
"objectGroups": []
},

{
"description": "The index of the first variable that equals to a specific number in an array.",
"fullName": "Index of number",
Expand Down