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)
:stcontrol(
)
Stcontrol = Returns the stcontrol stored in the array under specified index. Deprecated, use R[N,stcontrol] instead (5 ops)
=
:matrix(
)
Returns the matrix stored in the array under specified index. Deprecated, use R[N,matrix] instead (5 ops)
:effect(
)
Effect = Returns the effect stored in the array under specified index. Deprecated, use R[N,effect] instead (5 ops)
=
:string(
)
Returns the string stored in the array under specified index. Deprecated, use R[N,string] instead (5 ops)
=
:complex(
)
Returns the complex stored in the array under specified index. Deprecated, use R[N,complex] instead (5 ops)
=
:entity(
)
Returns the entity stored in the array under specified index. Deprecated, use R[N,entity] instead (5 ops)
=
:matrix4(
)
Returns the matrix4 stored in the array under specified index. Deprecated, use R[N,matrix4] instead (5 ops)
:ftrace(
)
Ftrace = Returns the ftrace stored in the array under specified index. Deprecated, use R[N,ftrace] instead (5 ops)
=
:matrix2(
)
Returns the matrix2 stored in the array under specified index. Deprecated, use R[N,matrix2] instead (5 ops)
=
:wirelink(
)
Returns the wirelink stored in the array under specified index. Deprecated, use R[N,wirelink] instead (5 ops)
=
:vector4(
)
Returns the vector4 stored in the array under specified index. Deprecated, use R[N,vector4] instead (5 ops)
=
:quaternion(
)
Returns the quaternion stored in the array under specified index. Deprecated, use R[N,quaternion] instead (5 ops)
=
:ranger(
)
Returns the ranger stored in the array under specified index. Deprecated, use R[N,ranger] instead (5 ops)
:tracedata(
)
Tracedata = Returns the tracedata stored in the array under specified index. Deprecated, use R[N,tracedata] instead (5 ops)
=
:bone(
)
Returns the bone stored in the array under specified index. Deprecated, use R[N,bone] instead (5 ops)
=
:number(
)
Returns the number stored in the array under specified index. Deprecated, use R[N,number] instead (5 ops)
=
:angle(
)
Returns the angle stored in the array under specified index. Deprecated, use R[N,angle] instead (5 ops)
=
:vector(
)
Returns the vector stored in the array under specified index. Deprecated, use R[N,vector] instead (5 ops)
=
:setMatrix2(
,
)
Sets a variable at specified index. Deprecated, use R[N,matrix2] = X instead (5 ops)
=
:setMatrix4(
,
)
Sets a variable at specified index. Deprecated, use R[N,matrix4] = X instead (5 ops)
=
:setNumber(
,
)
Sets a variable at specified index. Deprecated, use R[N,number] = X instead (5 ops)
=
:setEntity(
,
)
Sets a variable at specified index. Deprecated, use R[N,entity] = X instead (5 ops)
:setTracedata(
, Tracedata)
Tracedata = Sets a variable at specified index. Deprecated, use R[N,tracedata] = X instead (5 ops)
=
:setBone(
,
)
Sets a variable at specified index. Deprecated, use R[N,bone] = X instead (5 ops)
:setFtrace(
, Ftrace)
Ftrace = Sets a variable at specified index. Deprecated, use R[N,ftrace] = X instead (5 ops)
=
:setAngle(
,
)
Sets a variable at specified index. Deprecated, use R[N,angle] = X instead (5 ops)
=
:setVector4(
,
)
Sets a variable at specified index. Deprecated, use R[N,vector4] = X instead (5 ops)
=
:setQuaternion(
,
)
Sets a variable at specified index. Deprecated, use R[N,quaternion] = X instead (5 ops)
:setEffect(
, Effect)
Effect = Sets a variable at specified index. Deprecated, use R[N,effect] = X instead (5 ops)
=
:setVector2(
,
)
Sets a variable at specified index. Deprecated, use R[N,vector2] = 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)
=
:setString(
,
)
Sets a variable at specified index. Deprecated, use R[N,string] = X instead (5 ops)
=
:setComplex(
,
)
Sets a variable at specified index. Deprecated, use R[N,complex] = X instead (5 ops)
:setStcontrol(
, Stcontrol)
Stcontrol = Sets a variable at specified index. Deprecated, use R[N,stcontrol] = X instead (5 ops)
=
:setMatrix(
,
)
Sets a variable at specified index. Deprecated, use R[N,matrix] = X instead (5 ops)
=
:setWirelink(
,
)
Sets a variable at specified index. Deprecated, use R[N,wirelink] = X instead (5 ops)
=
:pushAngle(
)
Saves the data at the end of the array (7 ops)
=
:pushVector4(
)
Saves the data at the end of the array (7 ops)
=
:pushVector(
)
Saves the data at the end of the array (7 ops)
=
:pushMatrix4(
)
Saves the data at the end of the array (7 ops)
=
:pushComplex(
)
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)
:pushEffect(Effect)
Effect = Saves the data at the end of the array (7 ops)
=
:pushWirelink(
)
Saves the data at the end of the array (7 ops)
:pushFtrace(Ftrace)
Ftrace = Saves the data at the end of the array (7 ops)
:pushStcontrol(Stcontrol)
Stcontrol = Saves the data at the end of the array (7 ops)
:pushTracedata(Tracedata)
Tracedata = Saves the data at the end of the array (7 ops)
=
:pushVector2(
)
Saves the data at the end of the array (7 ops)
=
:pushBone(
)
Saves the data at the end of the array (7 ops)
=
:pushNumber(
)
Saves the data at the end of the array (7 ops)
=
:pushMatrix2(
)
Saves the data at the end of the array (7 ops)
=
:pushQuaternion(
)
Saves the data at the end of the array (7 ops)
=
:pushMatrix(
)
Saves the data at the end of the array (7 ops)
=
:pushString(
)
Saves the data at the end of the array (7 ops)
=
:insertVector4(
,
)
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)
:insertEffect(
, Effect)
Effect = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertStcontrol(
, Stcontrol)
Stcontrol = Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
:insertTracedata(
, Tracedata)
Tracedata = 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)
=
:insertEntity(
,
)
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)
:insertFtrace(
, Ftrace)
Ftrace = 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)
=
:insertMatrix2(
,
)
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)
=
:insertString(
,
)
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)
=
:insertBone(
,
)
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)
=
:insertVector(
,
)
Inserts the variable at the specified position. Moves all other indexes up one step to compensate (7 ops)
=
:insertNumber(
,
)
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)
=
: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)
=
: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)
=
: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)
=
: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)
=
: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)
=
: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)
=
: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)
=
: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)
:popTracedata()
Tracedata = 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)
:popStcontrol()
Stcontrol = 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)
=
: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)
=
: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)
=
: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)
: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)
:popFtrace()
Ftrace = 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)
=
: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)
:unshiftStcontrol(Stcontrol)
Stcontrol = 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)
=
:unshiftNumber(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftFtrace(Ftrace)
Ftrace = Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
:unshiftTracedata(Tracedata)
Tracedata = 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)
=
:unshiftWirelink(
)
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)
=
:unshiftVector(
)
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)
=
:unshiftMatrix(
)
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)
=
:unshiftString(
)
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)
=
:unshiftMatrix4(
)
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)
=
:unshiftBone(
)
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)
=
:unshiftMatrix2(
)
Adds the data to the beginning of the array. Will move all other entries up one address (7 ops)
=
:shiftComplex()
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)
=
:shiftWirelink()
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)
:shiftEffect()
Effect = 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)
=
:shiftEntity()
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)
=
:shiftBone()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftStcontrol()
Stcontrol = 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)
=
:shiftRanger()
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)
=
:shiftMatrix4()
Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftTracedata()
Tracedata = Deletes and returns the first element of the array, moving other entries down one address to compensate (7 ops)
:shiftFtrace()
Ftrace = 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)
=
:shiftVector4()
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)
=
:removeMatrix4(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeFtrace(
)
Ftrace = 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)
:removeStcontrol(
)
Stcontrol = 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)
=
:removeWirelink(
)
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)
=
:removeComplex(
)
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)
=
:removeVector(
)
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)
=
:removeRanger(
)
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)
=
:removeMatrix2(
)
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)
=
:removeBone(
)
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)
=
:removeVector4(
)
Deletes and returns the specified entry, moving subsequent entries down to compensate (7 ops)
:removeTracedata(
)
Tracedata = Deletes and returns the specified entry, moving subsequent entries down to compensate (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)