Skip to content

Commit 21fd156

Browse files
author
GDevelop documentation CI
committed
Automatic update of the reference pages [skip ci]
1 parent e2931f1 commit 21fd156

File tree

6 files changed

+28
-268
lines changed

6 files changed

+28
-268
lines changed

docs/gdevelop5/extensions/.pages

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ nav:
1414
- Extended math support: extended-math
1515
- Frames per second (FPS): fps
1616
- Hash: hash
17-
- Object picking tools: object-picking-tools
1817
- Read pixels: read-pixels
1918
- Record: record
2019
- Regular Expressions: reg-ex
@@ -55,7 +54,7 @@ nav:
5554
- Values of multiple objects: values-of-multiple-objects
5655
- General:
5756
- Array tools: array-tools
58-
- Extended variables support: extended-variables
57+
- Variables copier: extended-variables
5958
- Repeat every X seconds: repeat-every-xseconds
6059
- Input:
6160
- Android back button: back-button
@@ -164,6 +163,7 @@ nav:
164163
- Advanced:
165164
- Crypto Api: crypto-api
166165
- Game properties data: get-properties-data
166+
- Unpicks all instances: object-picking-tools
167167
- Random Color Generator: random-color
168168
- Rotate a string 13 characters: rotate13
169169
- Audio:
Lines changed: 9 additions & 160 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,13 @@
1-
# Extended variables support
1+
# Variables copier
22

33
<img src="https://resources.gdevelop-app.com/assets/Icons/variable-box.svg" class="extension-icon"></img>
4-
Check variable existence, copy, delete, and create dynamic variables at runtime.
4+
Copy structure and array variables.
55

66
**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [D8H](https://gd.games/D8H).
77

88
---
99

10-
This extension provides:
11-
12-
- Conditions to check if a global/scene/object variable exists.
13-
- Actions to copy object variables, global and scene variables.
14-
- Actions to delete an existing global/scene variable from memory.
15-
- Actions to create a global/scene variable using a text expression, rather than a variable name input.
16-
- Expressions to get the value or text from a global/scene variable using a text expression, rather than a variable name.
17-
18-
Text expressions allows to enter the name of the variable with an expression like `"MyVar"+ ToString(Variable(Health))`
10+
Copy all the children of a structure or an array into another variable.
1911

2012
!!! tip
2113
Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide.
@@ -35,19 +27,6 @@ Copy all object variables from one object to another.
3527

3628
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyAllObjectVariables`.
3729

38-
**Copy a global variable to scene**
39-
Copy the global variable to scene. This copy everything from the types to the values.
40-
41-
??? quote "See parameters & details"
42-
43-
- Parameter 1 (🔤 String): Global variable to copy
44-
- Parameter 2 (🔤 String): Scene variable destination
45-
- Parameter 3 (❓ Yes or No): Clear the destination variable before copying
46-
47-
> Technical note: parameters 0, 4 are internal parameters handled by GDevelop.
48-
49-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyGlobalVariableToScene`.
50-
5130
**Copy an object variable**
5231
Copy the object variable from one object to another.
5332

@@ -64,153 +43,23 @@ Copy the object variable from one object to another.
6443

6544
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyObjectVariable`.
6645

67-
**Copy a scene variable to global **
68-
Copy the scene variable to global. This copy everything from the types to the values.
46+
**Copy a variable**
47+
Copy all the chidren of a variable into another variable.
6948

7049
??? quote "See parameters & details"
7150

72-
- Parameter 1 (🔤 String): Scene variable to copy
73-
- Parameter 2 (🔤 String): Global variable destination
51+
- Parameter 1 (🗄️ Any variable): Variable to copy
52+
- Parameter 2 (🗄️ Any variable): Destination variable
7453
- Parameter 3 (❓ Yes or No): Clear the destination variable before copying
7554

7655
> Technical note: parameters 0, 4 are internal parameters handled by GDevelop.
7756

78-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopySceneVariableToGlobal`.
79-
80-
**Delete global variable**
81-
Delete the global variable, removing it from memory.
82-
83-
??? quote "See parameters & details"
84-
85-
- Parameter 1 (🔤 String): Name of the global variable to delete
86-
87-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
88-
89-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::DeleteGlobalVariable`.
90-
91-
**Delete object variable**
92-
Delete an object variable, removing it from memory.
93-
94-
??? quote "See parameters & details"
95-
96-
- Parameter 1: 👾 Object
97-
- Parameter 2 (🔤 String): Name of object variable
98-
99-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
100-
101-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::DeleteObjectVariable`.
102-
103-
**Delete scene variable**
104-
Delete the scene variable, the variable will be deleted from the memory.
105-
106-
??? quote "See parameters & details"
107-
108-
- Parameter 1 (🔤 String): Name of the scene variable to delete
109-
110-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
111-
112-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::DeleteSceneVariable`.
113-
114-
**Value of a global variable**
115-
Modify the value of a global variable.
116-
117-
??? quote "See parameters & details"
118-
119-
- Parameter 1 (🔤 String): Name of the global variable
120-
- Parameter 2 (🔢 Number): Value
121-
122-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
123-
124-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifyGlobalVariable`.
125-
126-
**String of a global variable**
127-
Modify the text of a global variable.
128-
129-
??? quote "See parameters & details"
130-
131-
- Parameter 1 (🔤 String): Name of the global variable
132-
- Parameter 2 (🔤 String): Value
133-
134-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
135-
136-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifyGlobalVariableString`.
137-
138-
**Value of a scene variable**
139-
Modify the value of a scene variable.
140-
141-
??? quote "See parameters & details"
142-
143-
- Parameter 1 (🔤 String): Name of the scene variable
144-
- Parameter 2 (🔢 Number): Value
145-
146-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
147-
148-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifySceneVariable`.
149-
150-
**String of a scene variable**
151-
Modify the text of a scene variable.
152-
153-
??? quote "See parameters & details"
154-
155-
- Parameter 1 (🔤 String): Name of the scene variable
156-
- Parameter 2 (🔤 String): Value
157-
158-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
159-
160-
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifySceneVariableString`.
161-
162-
163-
## Conditions
164-
165-
**Global variable exists**
166-
Check if the global variable exists.
167-
168-
??? quote "See parameters & details"
169-
170-
- Parameter 1 (🔤 String): Name of the global variable
171-
172-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
173-
174-
> Technical note: this condition internal type (in GDevelop JSON) is `ExtendedVariables::GlobalVariableExist`.
175-
176-
**Object variable exists**
177-
Check if an object variable exists.
178-
179-
??? quote "See parameters & details"
180-
181-
- Parameter 1: 👾 Object
182-
- Parameter 2 (🔤 String): Name of object variable
183-
184-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
185-
186-
> Technical note: this condition internal type (in GDevelop JSON) is `ExtendedVariables::ObjectVariableExist`.
187-
188-
**Scene variable exists**
189-
Check if the scene variable exists.
190-
191-
??? quote "See parameters & details"
192-
193-
- Parameter 1 (🔤 String): Name of the scene variable
194-
195-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
196-
197-
> Technical note: this condition internal type (in GDevelop JSON) is `ExtendedVariables::SceneVariableExist`.
57+
> Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyVariable`.
19858

19959

200-
## Expressions
20160

202-
| Expression | Description | |
203-
|-----|-----|-----|
204-
| `ExtendedVariables::GlobalVariable(string)` | Return the value of a global variable. ||
205-
| | _🔤 String_ | Name of the global variable |
206-
| `ExtendedVariables::GlobalVariableString(string)` | Return the text of a global variable. ||
207-
| | _🔤 String_ | Name of the global variable |
208-
| `ExtendedVariables::Variable(string)` | Return the value of a scene variable. ||
209-
| | _🔤 String_ | Name of the scene variable |
210-
| `ExtendedVariables::VariableString(string)` | Return the text of a scene variable. ||
211-
| | _🔤 String_ | Name of the scene variable |
21261

21362

21463
---
21564

216-
*This page is an auto-generated reference page about the **Extended variables support** extension for [GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop extensions here](/gdevelop5/extensions).
65+
*This page is an auto-generated reference page about the **Variables copier** extension for [GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop extensions here](/gdevelop5/extensions).

docs/gdevelop5/extensions/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ Read more about this:
3737
|<img src="https://resources.gdevelop-app.com/assets/Icons/function-variant.svg" class="extension-icon"></img>|**Extended math support**|Extra math: clamp, map, lerp, factorial, fibonacci, distance, angle, conversions, constants.|[Read more...](/gdevelop5/extensions/extended-math)|
3838
|<img src="https://resources.gdevelop-app.com/assets/Icons/Glyphster Pack/Master/SVG/SEO/SEO_board_performance_profit.svg" class="extension-icon"></img>|**Frames per second (FPS)**|Calculate and display frames per second (FPS).|[Read more...](/gdevelop5/extensions/fps)|
3939
|<img src="https://resources.gdevelop-app.com/assets/Icons/Glyphster Pack/Master/SVG/Security and Protection/Security and Protection_security_protection_delete_document_shredder.svg" class="extension-icon"></img>|**Hash**|Hash strings using MD5 or SHA256 algorithms.|[Read more...](/gdevelop5/extensions/hash)|
40-
|<img src="https://resources.gdevelop-app.com/assets/Icons/selection-ellipse-arrow-inside.svg" class="extension-icon"></img>|**Object picking tools**|Pick object instances by highest or lowest variable value, z-order, and more.|[Read more...](/gdevelop5/extensions/object-picking-tools)|
4140
|<img src="https://resources.gdevelop-app.com/assets/Icons/Glyphster Pack/Master/SVG/Computers and Hardware/Computers and Hardware_screen_computer_image.svg" class="extension-icon"></img>|**Read pixels**|Read the values of pixels on the screen.|[Read more...](/gdevelop5/extensions/read-pixels)|
4241
|<img src="https://resources.gdevelop-app.com/assets/Icons/video-vintage.svg" class="extension-icon"></img>|**Record**|Record gameplay as video clips for download.|[Read more...](/gdevelop5/extensions/record)|
4342
|<img src="https://resources.gdevelop-app.com/assets/Icons/regex.svg" class="extension-icon"></img>|**Regular Expressions**|Manipulates string with regular expressions.|[Read more...](/gdevelop5/extensions/reg-ex)|
@@ -94,7 +93,7 @@ Read more about this:
9493
||Name|Description||
9594
|---|---|---|---|
9695
|<img src="https://asset-resources.gdevelop.io/public-resources/Icons/Line Hero Pack/Master/SVG/Text Editing/9bfb52500e68d0fd164b1e30bc696e40566187245b80c345848379f40bb6fad7_Text Editing_bullet_points_list.svg" class="extension-icon"></img>|**Array tools**|Array utilities: search, sort, shuffle, slice, concat, reverse, pop, random element access.|[Read more...](/gdevelop5/extensions/array-tools)|
97-
|<img src="https://resources.gdevelop-app.com/assets/Icons/variable-box.svg" class="extension-icon"></img>|**Extended variables support**|Check variable existence, copy, delete, and create dynamic variables at runtime.|[Read more...](/gdevelop5/extensions/extended-variables)|
96+
|<img src="https://resources.gdevelop-app.com/assets/Icons/variable-box.svg" class="extension-icon"></img>|**Variables copier**|Copy structure and array variables.|[Read more...](/gdevelop5/extensions/extended-variables)|
9897
|<img src="https://resources.gdevelop-app.com/assets/Icons/repeat.svg" class="extension-icon"></img>|**Repeat every X seconds**|Trigger an action repeatedly at a configurable time interval in seconds.|[Read more...](/gdevelop5/extensions/repeat-every-xseconds)|
9998

10099
### Input
@@ -236,6 +235,7 @@ guarantee they meet all the quality standards of fully reviewed extensions.
236235
|---|---|---|---|
237236
|<img src="https://asset-resources.gdevelop.io/public-resources/Icons/fac7ecb74ef7da92ab59c3e431fb9587c105c2889a41cfac489135c0eb4643d1_shield-key.svg" class="extension-icon"></img>|**Crypto Api**|Random number generator for integers and floats using the Crypto API.|[Read more...](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues) ([reference](/gdevelop5/extensions/crypto-api))|
238237
|<img src="https://resources.gdevelop-app.com/assets/Icons/numeric.svg" class="extension-icon"></img>|**Game properties data**|Get Version, Title, Publisher name, PackageName from properties tab.|[Read more...](/gdevelop5/extensions/get-properties-data)|
238+
|<img src="https://resources.gdevelop-app.com/assets/Icons/selection-ellipse-arrow-inside.svg" class="extension-icon"></img>|**Unpicks all instances**|Unpick all instances of an object.|[Read more...](/gdevelop5/extensions/object-picking-tools)|
239239
|<img src="https://resources.gdevelop-app.com/assets/Icons/format-color-fill.svg" class="extension-icon"></img>|**Random Color Generator**|Create a random color for a scene, an object, or any other color input.|[Read more...](/gdevelop5/extensions/random-color)|
240240
|<img src="https://resources.gdevelop-app.com/assets/Icons/format-text-rotation-none.svg" class="extension-icon"></img>|**Rotate a string 13 characters**|This extension rotates all alphabetic characters in a string by 13 characters.|[Read more...](/gdevelop5/extensions/rotate13)|
241241

Lines changed: 9 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,24 @@
1-
# Object picking tools
1+
# Unpicks all instances
22

33
<img src="https://resources.gdevelop-app.com/assets/Icons/selection-ellipse-arrow-inside.svg" class="extension-icon"></img>
4-
Pick object instances by highest or lowest variable value, z-order, and more.
4+
Unpick all instances of an object.
55

66
**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [VictrisGames](https://gd.games/VictrisGames).
77

8-
---
8+
!!! warning
9+
This is an extension made by a community member and it only got through a
10+
light review by the GDevelop extension team. As such, we can't guarantee it
11+
meets all the quality standards of fully reviewed extensions.
912

10-
Adds various actions and conditions for advanced object selection. Includes picking objects with the highest or lowest Z-order (for 2D objects), an object variable, and the ability to unpick all objects.
13+
---
1114

12-
If multiple instances have the highest/lowest Z-order, all of these instances will be picked.
15+
Unpick all instances of an object to only pick objects created by following actions.
1316

1417
!!! tip
1518
Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide.
1619

1720
## Actions
1821

19-
**Pick objects with highest variable value**
20-
Pick object instances that have the highest value of an object variable.
21-
22-
??? quote "See parameters & details"
23-
24-
- Parameter 1 (👾 Object): Object to select instances from
25-
- Parameter 2 (🔤 String): Object variable name
26-
27-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
28-
29-
> Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestVariableValueAction`.
30-
31-
**Pick objects with highest Z-order**
32-
Pick object instances that have the highest Z-order.
33-
34-
??? quote "See parameters & details"
35-
36-
- Parameter 1 (👾 Object): Object to select instances from
37-
38-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
39-
40-
> Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestZAction`.
41-
42-
**Pick objects with lowest variable value**
43-
Pick object instances that have the lowest value of an object variable.
44-
45-
??? quote "See parameters & details"
46-
47-
- Parameter 1 (👾 Object): Object to select instances from
48-
- Parameter 2 (🔤 String): Object variable name
49-
50-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
51-
52-
> Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestVariableValueAction`.
53-
54-
**Pick objects with lowest Z-order**
55-
Pick object instances that have the lowest Z-order.
56-
57-
??? quote "See parameters & details"
58-
59-
- Parameter 1 (👾 Object): Object to select instances from
60-
61-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
62-
63-
> Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestZAction`.
64-
6522
**Unpick all instances**
6623
Unpicks all instances of an object.
6724

@@ -76,52 +33,6 @@ Unpicks all instances of an object.
7633

7734
## Conditions
7835

79-
**Pick objects with highest variable value**
80-
Pick object instances that have the highest value of an object variable.
81-
82-
??? quote "See parameters & details"
83-
84-
- Parameter 1 (👾 Object): Object to select instances from
85-
- Parameter 2 (🔤 String): Object variable name
86-
87-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
88-
89-
> Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestVariableValueCondition`.
90-
91-
**Pick objects with highest Z-order**
92-
Pick object instances that have the highest Z-order.
93-
94-
??? quote "See parameters & details"
95-
96-
- Parameter 1 (👾 Object): Object to select instances from
97-
98-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
99-
100-
> Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestZCondition`.
101-
102-
**Pick objects with lowest variable value**
103-
Pick object instances that have the lowest value of an object variable.
104-
105-
??? quote "See parameters & details"
106-
107-
- Parameter 1 (👾 Object): Object to select instances from
108-
- Parameter 2 (🔤 String): Object variable name
109-
110-
> Technical note: parameters 0, 3 are internal parameters handled by GDevelop.
111-
112-
> Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestVariableValueCondition`.
113-
114-
**Pick objects with lowest Z-order**
115-
Pick object instances that have the lowest Z-order.
116-
117-
??? quote "See parameters & details"
118-
119-
- Parameter 1 (👾 Object): Object to select instances from
120-
121-
> Technical note: parameters 0, 2 are internal parameters handled by GDevelop.
122-
123-
> Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestZCondition`.
124-
12536
**Unpick all instances**
12637
Unpicks all instances of an object.
12738

@@ -139,4 +50,4 @@ Unpicks all instances of an object.
13950

14051
---
14152

142-
*This page is an auto-generated reference page about the **Object picking tools** extension for [GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop extensions here](/gdevelop5/extensions).
53+
*This page is an auto-generated reference page about the **Unpicks all instances** extension for [GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop extensions here](/gdevelop5/extensions).

0 commit comments

Comments
 (0)