e2 docs array - wiremod/wire GitHub Wiki
Array
= array(...)
Creates an array (1 ops)
=
:vector2(
)
Returns the vector2 stored in the array under specified index. Deprecated, use R[N,vector2] instead (5 ops)
=
:vector(
)
Returns the vector stored in the array under specified index. Deprecated, use R[N,vector] instead (5 ops)
=
:matrix2(
)
Returns the matrix2 stored in the array under specified index. Deprecated, use R[N,matrix2] instead (5 ops)
=
:matrix4(
)
Returns the matrix4 stored in the array under specified index. Deprecated, use R[N,matrix4] instead (5 ops)
=
:wirelink(
)
Returns the wirelink stored in the array under specified index. Deprecated, use R[N,wirelink] instead (5 ops)
=
:entity(
)
Returns the entity stored in the array under specified index. Deprecated, use R[N,entity] instead (5 ops)
=
:string(
)
Returns the string stored in the array under specified index. Deprecated, use R[N,string] instead (5 ops)
:movedata(
)
Movedata = Returns the movedata stored in the array under specified index. Deprecated, use R[N,movedata] instead (5 ops)
=
:vector4(
)
Returns the vector4 stored in the array under specified index. Deprecated, use R[N,vector4] instead (5 ops)
=
:complex(
)
Returns the complex stored in the array under specified index. Deprecated, use R[N,complex] instead (5 ops)
=
:ranger(
)
Returns the ranger stored in the array under specified index. Deprecated, use R[N,ranger] instead (5 ops)
=
:angle(
)
Returns the angle stored in the array under specified index. Deprecated, use R[N,angle] instead (5 ops)
:function(
)
Function = Returns the function stored in the array under specified index. Deprecated, use R[N,function] instead (5 ops)
=
:quaternion(
)
Returns the quaternion stored in the array under specified index. Deprecated, use R[N,quaternion] instead (5 ops)
:damage(
)
Damage = Returns the damage stored in the array under specified index. Deprecated, use R[N,damage] instead (5 ops)
:egpobject(
)
Egpobject = Returns the egpobject stored in the array under specified index. Deprecated, use R[N,egpobject] instead (5 ops)
:collision(
)
Collision = Returns the collision stored in the array under specified index. Deprecated, use R[N,collision] instead (5 ops)
:effect(
)
Effect = Returns the effect stored in the array under specified index. Deprecated, use R[N,effect] instead (5 ops)
=
:number(
)
Returns the number stored in the array under specified index. Deprecated, use R[N,number] instead (5 ops)
=
:bone(
)
Returns the bone stored in the array under specified index. Deprecated, use R[N,bone] instead (5 ops)
:usercmd(
)
Usercmd = Returns the usercmd stored in the array under specified index. Deprecated, use R[N,usercmd] instead (5 ops)
=
:matrix(
)
Returns the matrix stored in the array under specified index. Deprecated, use R[N,matrix] instead (5 ops)
=
:setNumber(
,
)
Sets a variable at specified index. Deprecated, use R[N,number] = X instead (5 ops)
=
:setMatrix2(
,
)
Sets a variable at specified index. Deprecated, use R[N,matrix2] = X instead (5 ops)
:setMovedata(
, Movedata)
Movedata = Sets a variable at specified index. Deprecated, use R[N,movedata] = X instead (5 ops)
:setEffect(
, Effect)
Effect = Sets a variable at specified index. Deprecated, use R[N,effect] = X instead (5 ops)
=
:setAngle(
,
)
Sets a variable at specified index. Deprecated, use R[N,angle] = X instead (5 ops)
:setCollision(
, Collision)
Collision = Sets a variable at specified index. Deprecated, use R[N,collision] = X instead (5 ops)
=
:setBone(
,
)
Sets a variable at specified index. Deprecated, use R[N,bone] = X instead (5 ops)
=
:setVector4(
,
)
Sets a variable at specified index. Deprecated, use R[N,vector4] = X instead (5 ops)
=
:setString(
,
)
Sets a variable at specified index. Deprecated, use R[N,string] = X instead (5 ops)
=
:setMatrix4(
,
)
Sets a variable at specified index. Deprecated, use R[N,matrix4] = X instead (5 ops)
:setUsercmd(
, Usercmd)
Usercmd = Sets a variable at specified index. Deprecated, use R[N,usercmd] = X instead (5 ops)
=
:setWirelink(
,
)
Sets a variable at specified index. Deprecated, use R[N,wirelink] = X instead (5 ops)
=
:setVector2(
,
)
Sets a variable at specified index. Deprecated, use R[N,vector2] = X instead (5 ops)
=
:setEntity(
,
)
Sets a variable at specified index. Deprecated, use R[N,entity] = X instead (5 ops)
=
:setVector(
,
)
Sets a variable at specified index. Deprecated, use R[N,vector] = X instead (5 ops)
=
:setRanger(
,
)
Sets a variable at specified index. Deprecated, use R[N,ranger] = X instead (5 ops)
=
:setQuaternion(
,
)
Sets a variable at specified index. Deprecated, use R[N,quaternion] = X instead (5 ops)
:setFunction(
, Function)
Function = Sets a variable at specified index. Deprecated, use R[N,function] = X instead (5 ops)
=
:setComplex(
,
)
Sets a variable at specified index. Deprecated, use R[N,complex] = X instead (5 ops)
:setEgpobject(
, Egpobject)
Egpobject = Sets a variable at specified index. Deprecated, use R[N,egpobject] = X instead (5 ops)
:setDamage(
, Damage)
Damage = Sets a variable at specified index. Deprecated, use R[N,damage] = X instead (5 ops)
=
:setMatrix(
,
)
Sets a variable at specified index. Deprecated, use R[N,matrix] = X instead (5 ops)
=
:pushString(
)
Saves the data at the end of the array (7 ops)
=
:pushNumber(
)
Saves the data at the end of the array (7 ops)
=
:pushVector(
)
Saves the data at the end of the array (7 ops)
=
:pushQuaternion(
)
Saves the data at the end of the array (7 ops)
=
:pushWirelink(
)
Saves the data at the end of the array (7 ops)
:pushMovedata(Movedata)
Movedata = Saves the data at the end of the array (7 ops)
:pushEffect(Effect)
Effect = Saves the data at the end of the array (7 ops)
:pushCollision(Collision)
Collision = Saves the data at the end of the array (7 ops)
:pushFunction(Function)
Function = Saves the data at the end of the array (7 ops)
:pushDamage(Damage)
Damage = Saves the data at the end of the array (7 ops)
=
:pushMatrix2(
)
Saves the data at the end of the array (7 ops)
=
:pushMatrix(
)
Saves the data at the end of the array (7 ops)
=
:pushComplex(
)
Saves the data at the end of the array (7 ops)
=
:pushBone(
)
Saves the data at the end of the array (7 ops)
=
:pushRanger(
)
Saves the data at the end of the array (7 ops)
=
:pushEntity(
)
Saves the data at the end of the array (7 ops)
=
:pushVector2(
)
Saves the data at the end of the array (7 ops)
=
:pushVector4(
)
Saves the data at the end of the array (7 ops)
:pushEgpobject(Egpobject)
Egpobject = Saves the data at the end of the array (7 ops)
=
:pushAngle(
)
Saves the data at the end of the array (7 ops)
=
:pushMatrix4(
)
Saves the data at the end of the array (7 ops)
:pushUsercmd(Usercmd)
Usercmd = Saves the data at the end of the array (7 ops)
=
:insertNumber(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertEffect(
, Effect)
Effect = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertMovedata(
, Movedata)
Movedata = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertDamage(
, Damage)
Damage = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertUsercmd(
, Usercmd)
Usercmd = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertRanger(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertAngle(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertMatrix(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertEgpobject(
, Egpobject)
Egpobject = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertVector4(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertMatrix4(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertString(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertBone(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertCollision(
, Collision)
Collision = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertEntity(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertComplex(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertFunction(
, Function)
Function = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertQuaternion(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertMatrix2(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertWirelink(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertVector(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertVector2(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:popAngle()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popVector()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popMatrix4()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popEntity()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popRanger()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popBone()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popString()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popUsercmd()
Usercmd = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popVector4()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popQuaternion()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popMovedata()
Movedata = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popDamage()
Damage = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popVector2()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popCollision()
Collision = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popFunction()
Function = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popMatrix()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popComplex()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popMatrix2()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popWirelink()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:popNumber()
Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popEffect()
Effect = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
:popEgpobject()
Egpobject = Deletes and returns the last entry in the array. Be sure not to use popNumber() on a vector or similar, as the data may be lost (7 ops)
=
:unshiftMatrix4(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftVector4(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftAngle(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftWirelink(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftUsercmd(Usercmd)
Usercmd = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftEgpobject(Egpobject)
Egpobject = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftRanger(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftFunction(Function)
Function = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftMovedata(Movedata)
Movedata = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftDamage(Damage)
Damage = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftVector(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftBone(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftEntity(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftQuaternion(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftVector2(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftString(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftNumber(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftCollision(Collision)
Collision = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftEffect(Effect)
Effect = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftMatrix(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftComplex(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:unshiftMatrix2(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:shiftEgpobject()
Egpobject = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftEntity()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftAngle()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftCollision()
Collision = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftMatrix2()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftFunction()
Function = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftComplex()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftDamage()
Damage = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftString()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftVector()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftRanger()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftVector2()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftBone()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftMatrix4()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftUsercmd()
Usercmd = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftMatrix()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftVector4()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftNumber()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftQuaternion()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftEffect()
Effect = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:shiftWirelink()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftMovedata()
Movedata = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
=
:removeVector(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeFunction(
)
Function = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeEntity(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeBone(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeComplex(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeVector2(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeWirelink(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeDamage(
)
Damage = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeMatrix(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeNumber(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeMatrix2(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeMovedata(
)
Movedata = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeVector4(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeCollision(
)
Collision = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeQuaternion(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeRanger(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeEgpobject(
)
Egpobject = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeUsercmd(
)
Usercmd = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeMatrix4(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeEffect(
)
Effect = Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeString(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:removeAngle(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(Damage Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(Effect Value)
(7 ops)
=
:indexOf(Movedata Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(Collision Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(Function Value)
(7 ops)
=
:indexOf(Usercmd Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:indexOf(Egpobject Value)
(7 ops)
=
:indexOf(
Value)
(7 ops)
=
:pop()
Removes the last entry in the array and returns 1 if removed (2 ops)
=
:shift()
Removes the first element of the array; all other entries will move down one address and returns 1 if removed (3 ops)
=
:remove(
Index)
Removes the specified entry, moving subsequent entries down to compensate and returns 1 if removed (2 ops)
=
:unset(
Index)
Force removes the specified entry, without moving subsequent entries down and returns 1 if removed (2 ops)
=
:exists(
Index)
Returns 1 if the array contains any value at specified index (1 ops)
=
:count()
Returns the number of entries in the array (3 ops)
:clear()
Clears the array (1 ops)
=
:clone()
Returns a copy of the array (1 ops)
=
:sum()
Adds all numbers in the array together and returns result (1 ops)
=
:average()
Gives the average of all numbers in array (1 ops)
=
:min()
Returns the smallest number in array (1 ops)
=
:minIndex()
Returns the index of the smallest number in array (1 ops)
=
:max()
Returns the largest number in array (1 ops)
=
:maxIndex()
Returns the index of the largest number in array (1 ops)
=
:concat()
Concatenates all values in the array (1 ops)
=
:concat(
Delimiter)
Concatenates all values in the array with the specified string in between each (1 ops)
=
:concat(
Delimiter,
Startindex)
Concatenates all values in the array, starting at index N, with string S in between each (1 ops)
=
:concat(
Delimiter,
Startindex,
Endindex)
Concatenates all values in the array, starting at index N1 and ending at N2, with string S in between each (1 ops)
=
:concat(
Startindex)
Concatenates all values in the array, starting at index N (1 ops)
=
:concat(
Startindex,
Endindex)
Concatenates all values in the array, starting at index N1 and ending at N2 (1 ops)
=
:id()
Returns the unique ID of the array (1 ops)
=
:add(
Other)
Adds the contents of the second array to the end of the first array. Returns new array (1 ops)
=
:merge(
Other)
Merges R2 with R. Any variables with the same indexes are overwritten by R2's variables (1 ops)
= toString(
Array)
Returns a string representation of the array and its contents for debugging purposes. Return format may change in the future and should not be relied on. (2 ops)
=
:toString()
Returns a string representation of the array and its contents for debugging purposes. Return format may change in the future and should not be relied on. (2 ops)