Set¶

Name	Mandatory	Description	Default	Type
`⬅️ Input`		The value to be set to the variable.		`Any`
`Output ➡️`		The input value is passed through as the output.		`Any`
`Name`	No	The name of the variable.	``	`StringVar(Any)`
`Key`	No	The key of the value to write in the table (parameter applicable only if the target variable is a table).	`none`	`Any`
`Global`	No	If the variable is available to all of the wires in the same mesh.	`false`	`Bool`
`TrackingMask`	No	If not 0, they variable will emit events when updated, according to the tracking mask, 8bits.	`0`	`Int`

Creates a mutable variable and assigns a value to it.

Details¶

If theKey parameter is specified, Set will create a table variable. The input becomes the value of the key that was passed in parameter Key.

The Global: parameter controls whether the created variables can be referenced across wires (:Global set to true) or only within the current wire (Global: set to false, default behaviour).

Though it will generate a warning Set can also be used to update existing variables (like adding a new key-value pair to an existing table, or updating the value of a key in an existing table).

Variables may be locally scoped (created with (Global: false); exists only for current wire) or globally scoped (created with (Global: true); exists for all wires of that mesh). Hence, in update mode (i.e. when you apply Set to an existing variable) the Global parameter is used in conjunction with the Name parameter to identify the correct variable to update.

Note

Set has an alias >=.

Examples¶

Code

// create a mutable string variable, modify it (by default available only to current wire)
"Hello" | Set(Name: svar)
svar | Log(".svar") // => .svar: Hello
"World" | Update(svar) // modify string variable
svar | Log("modified .svar") // => .svar: World

// create a mutable numeric variable, modify it (available to all wires because Global: true)
100 | Set(Name: nvar Global: true)
nvar | Log(".nvar") // => .nvar: 100
200 | Update(nvar) // modify numeric variable
nvar | Log("modified .nvar") // => modified .nvar: 200

// create a mutable sequence
[10 20 30] | Set(Name: sequence)
sequence | Log(".sequence") // => .sequence: [10, 20, 30]

// create a mutable table
["a" "b"] | Set(Name: table Key: "key1")
table | Log(".table") // => .table: {key1: [a, b]}

// add a key-value pair to existing mutable table (will generate warnings)
"def" | Set(table Key: "key2") // add new key
table | Log("modified .table") // => modified .table: {key2: def, key1: [a, b]}

// Using Set aliases
// >= is alias for Set(Global: false): create a mutable string variable
"World" >= svarA
svarA | Log(".svarA") // => .svarA: World

100 | Set(nvarA Global: true)
nvarA | Log(".nvarA") // => .nvarA: 100

// create and update local/global variables
"Local" | Set(str) // create local variable
"Global" | Set(str Global: true) // create same-name global variable
Get(str) | Log // get updated local variable => "Local"
Get(str Global: true) | Log // get same-name updated global variable => "Global"
"LocalNew" | Set(str) // create local variable
"GlobalNew" | Set(str Global: true) // create same-name global variable
Get(str) | Log // get updated local variable => "LocalNew"
Get(str Global: true) | Log // get same-name updated global variable => "GlobalNew"

[info] Set - Warning: setting an already exposed variable "str", use Update to avoid this warning.
[info] Set - Warning: setting an already exposed variable "str", use Update to avoid this warning.
[info] Set - Warning: setting an already exposed variable "str", use Update to avoid this warning.
[info] [sample-wire] .svar: Hello
[info] [sample-wire] modified .svar: World
[info] [sample-wire] .nvar: 100
[info] [sample-wire] modified .nvar: 200
[info] [sample-wire] .sequence: [10 20 30]
[info] [sample-wire] .table: {key1: [a b]}
[info] [sample-wire] modified .table: {key1: [a b] key2: def}
[info] [sample-wire] .svarA: World
[info] [sample-wire] .nvarA: 100
[info] [sample-wire] Local
[info] [sample-wire] Global
[info] [sample-wire] LocalNew
[info] [sample-wire] GlobalNew