Difference between revisions of "AuxiliaryVariableErase"
Jump to navigation
Jump to search
imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Erases the element at the specified <i>index</i> of the specified Auxiliary-Variable. If <i>index</i> is not spec...") |
imported>Jazzisparis |
||
| Line 4: | Line 4: | ||
|name = AuxiliaryVariableErase | |name = AuxiliaryVariableErase | ||
|alias = AuxVarErase | |alias = AuxVarErase | ||
|returnType = | |returnType = numElements:int | ||
|referenceType = reference | |referenceType = reference | ||
|arguments = | |arguments = | ||
| Line 23: | Line 23: | ||
AuxVarErase "someVarName" 2 ArmorCombat | AuxVarErase "someVarName" 2 ArmorCombat | ||
}} | }} | ||
==Notes== | |||
*The function returns the variable's new number of elements. | |||
==See Also== | ==See Also== | ||
[[Category:Functions_(JIP)]] | [[Category:Functions_(JIP)]] | ||
[[Category:Auxiliary-Variable Functions (JIP)]] | [[Category:Auxiliary-Variable Functions (JIP)]] | ||
Latest revision as of 07:33, 14 June 2015
< [[::Category:Functions|Category:Functions]]
A function added by the JIP NVSE Plugin.
Description
Erases the element at the specified index of the specified Auxiliary-Variable. If index is not specified, or equals -1, the variable, along with all its elements, will be erased.
Syntax
(numElements:int) reference.AuxiliaryVariableErase varName:string index:int baseForm:ref
Or:
(numElements:int) reference.AuxVarErase varName:string index:int baseForm:ref
Example
RaulRef.AuxiliaryVariableErase "someVarName"
AuxVarErase "someVarName" 2 ArmorCombat
Notes
- The function returns the variable's new number of elements.