Set Variable: Difference between revisions

Set Variable
Type	Script block
Collider	None
Folder	Variables
Ports
Inputs	Before; Value;
Outputs	After;

Latest revision as of 16:18, 28 June 2024

Stores the input value into a variable.

See Variables for more information.

Notes

If Value remains not wired, the variable will not be overwritten. This could be used to provide default values for a custom script block:

@@ Line 1: / Line 1: @@
-Stores the input value into a variable. Think of a variable as a container with a nametag that can only store one value at a time. If you were to set another value to a variable, it will overwrite the previous value of that variable.
+{{Block
+|image=Set_Variable_number.png
+|type=s
+|folder=Variables
+|input1={{Port|e|Before}}
+|input2={{Port|?|Value}}
+|output1={{Port|e|After}}
+}}
-[[File:Set_Variable1.png]]
+Stores the input value into a variable.
-You can get/output the value from a variable with the same name using the [[Get Variable]] block.
+See [[Variables]] for more information.
-[[File:Screenshot_2021_1022_011555_com.martinmagni.fancade.png]]
+== Notes ==
-== Global variables ==
+If {{Port|?|Value}} remains not wired, the variable will not be overwritten.
+This could be used to provide default values for a custom script block:
-Let's say you have a script inside a block that sets a variable to 1. And you have a script outside of the block to inspect that variable.
+[[File:Set_Variable_default_value.png|thumb|none|Demonstration applying a default value, 2. The variable is global for inspection.]]
-[[File:20211022_012115.png]]
+== Related ==
-As you can see, we've set the variable to 1, but the Get Variable block outputs 0 as if we never set the variable in the first place.
-This is because those two variables are local, meaning they can't transfer variable information from one place to another (inside a block to outside the block, or into another block and vice versa).
-If we want a variable to share information to another variable in different places, then we would have to globalize them. You can simply press the Global button on the keyboard where you type the variable's name. Global variables gain a `$` at the start of their name.
-Note that two variables with the same name with one being a global will not count as the same variables (e.g Number and $Number are not the same).
-[[File:Screenshot_2021_1022_012758_com.martinmagni.fancade.png]]
-== Saved variables ==
-<<SeeAlso(/Script/Saved Variables)>>
-Saved variables were added in Fancade 1.6. Like global variables, you can make a saved variable by pressing the Local/Global/Saved button on the keyboard where you type the variable's name. Saved variables gain a `!` at the start of their name.
-[[File:Screenshot_2021_1022_012641_com.martinmagni.fancade.png]]
-As the name implies, saved variables persist their value from one game session to the next. This is true whether the user ends the game by winning, dying, or simply pausing and returning to the menu.
-Additionally, saved variables are shared across all levels in the same game. This allows a player's actions in one level to affect their gameplay in other levels, and to keep track of purchases from the [[Menu Item]] block.
-Saved variables currently only have number type and there can be up to 64 saved variables per game.
+* [[Variables]]
+* [[Get Variable]]
+* [[List Element]]
+* [[Set Reference]]
 [[Category:Blocks]]