Nosial/rtex-engine
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated documentation for base instructions

Browse source
This commit is contained in:
Netkas 2022-12-30 03:00:04 -05:00
parent dc0811a271
commit f071d1dc72
5 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/instructions/base/array_get.md
View file

@ -4,8 +4,8 @@ Get an item from an array using "dot" notation.
## Parameters ## Parameters
* array (`array`, `instruction`) - The array to get the value from. * array (`array`) - The array to get the value from.
* key (`string`, `instruction`) - The key to get the value for. * key (`string`) - The key to get the value for.
## Return ## Return

6
docs/instructions/base/array_set.md
View file

@ -4,9 +4,9 @@ Set an item in an array using "dot" notation.
## Parameters ## Parameters
* array (`array`, `instruction`) - The array to get the value from. * array (`array`) - The array to get the value from.
* key (`string`, `instruction`) - The key to get the value for. * key (`string`) - The key to get the value for.
* value (`any`, `instruction`) - The value to set. * value (`any`) - The value to set.
## Return ## Return

2
docs/instructions/base/get.md
View file

@ -4,7 +4,7 @@ Gets an existing variable from the environment.
## Parameters ## Parameters
* name (`string`, `instruction`) - The name of the variable to get. * name (`string`) - The name of the variable to get.
## Return ## Return

8
docs/instructions/base/invoke.md
View file

@ -4,10 +4,10 @@ Invokes a method under a namespace.
## Parameters ## Parameters
* namespace (`string`, `instruction`) - The namespace to invoke the method under. * namespace (`string`) - The namespace to invoke the method under.
* method (`string`, `instruction`) - The method to invoke. * method (`string`) - The method to invoke.
* parameters (`array`, `instruction`) - The parameters to pass to the method. * parameters (`array`) - The parameters to pass to the method.
* fail_on_error (`boolean`, `instruction`) - Whether to fail if the method throws an exception. * fail_on_error (`boolean`) - Whether to fail if the method throws an exception.
## Return ## Return

4
docs/instructions/base/set.md
View file

@ -4,8 +4,8 @@ Sets aor overwrites a variable in the environment.
## Parameters ## Parameters
* name (`string`, `instruction`) - The name of the variable to get. * name (`string`) - The name of the variable to get.
* value (`any`, `instruction`) - The value to set. * value (`any`) - The value to set.
## Return ## Return