|
|
Mechanic: VariableUnset
|
|
|
=======================
|
|
|
|
|
|
**Aliases:** varUnset, unsetVariable, unsetVar
|
|
|
|
|
|
## Description
|
|
|
Unsets a [variable](/skills/variables).
|
|
|
|
|
|
Attributes
|
|
|
----------
|
|
|
|
|
|
| Attribute | Aliases | Description | Default Value |
|
|
|
|-----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
|
|
| variable | var | The name of the variable. Can optionally be prefixed with **scope.** | |
|
|
|
| scope | s | The [scope](/skills/variables#variable_scopes) of the variable, e.g. where the variable will be located. | SKILL |
|
|
|
|
|
|
--------
|
|
|
## Attributes
|
|
|
> This mechanic inherits every *inheritable* attribute of the [SetVariable](skills/mechanics/setvariable) mechanic
|
|
|
|
|
|
This mechanic was added in 4.12
|
|
|
|
|
|
--------
|
|
|
|
|
|
Examples
|
|
|
----
|
|
|
|
|
|
## Examples
|
|
|
This will unset the testing caster scope variable from the caster.
|
|
|
|
|
|
```
|
|
|
```yaml
|
|
|
RemoveVariable:
|
|
|
Skills:
|
|
|
- variableUnset{var=caster.testing} @self
|
|
|
```
|
|
|
|
|
|
This will unset the testing caster scope variable from the caster as well.
|
|
|
```
|
|
|
```yaml
|
|
|
RemoveVariable:
|
|
|
Skills:
|
|
|
- variableUnset{var=testing;scope=caster} @self
|
|
|
``` |
|
|
\ No newline at end of file |
|
|
```
|
|
|
|
|
|
|
|
|
## Aliases
|
|
|
- [x] unsetvariable
|
|
|
- [x] unsetvar
|
|
|
- [x] varunset |
|
|
\ No newline at end of file |