IRPL Reference

Variables

$$Init_var (define hidden)
$init_var (define)
--! (RefDelete)
--varname (Delete)
->! (RefWrite)
->varname (Write)
-?! (RefExists)
-?varname (Exists)
<-! (Refread)
<-Varname (Read)
ClearGlobals
ClearLocals
Copy
DeepCopy

Functions

call
func
refcall

Logic

not
and
or
xor
true
false

Comparators

eq
eq0
neq
neq0
gt
gt0
gte
gte0
lt
lt0
lte
lte0

Constants

e
Pi
QuarterPi
HalfPi
ThreeQuarterPi
ThreeHalvesPi
TwoPi
Tau
Deg2Rad
Rad2Deg
Vector0
MaxInt
MinInt

Strings

Concat
Concat3
Concat4
TAB
LF (Line Feed)
CR (Carriage Return)
DQ (Double Quote)
GetTimeString
StartsWith
EndsWith
StringLength
StringToList
StringReplace
Substring
Split
RemoveWhiteSpace
ToLower
ToUpper

Data Type Manipulation

asint
asfloat
asstring
GetType
NULL
IsNull

Stack Manipulation

dup
dup2
pop
swap
StackSize
ClearStack

Debugging

Debug
DebugAllSp
Print
Print2
Print3
Print4
Print5
PrintAll
PrintAllSp
PrintStack
GetPrintPrefixEnabled
SetPrintPrefixEnabled
ClearPrintLog
Trace
Trace2
Trace3
Trace4
Trace5
TraceAll
TraceAllSp
TraceStack
ClearTraceLog

Flow Control

if
endif
else
once
endonce
do
loop
i
j
k
break
while
endwhile
repeat
switch
endswitch
case
endcase
return

Arithmetic

add
sub
mul
div
pow
mod
mod2

Math Utility

randint
randfloat
clamp
clamp01
pingpong
signalgenerator
numrepeat
movetowards
rotatetowards
rotatetowardscell
distance
distancecell
distancepointline
shortestangle
vectorangle
vectoranglecell

Math

round
approximately
max
min
avg2
neg
abs
sign
sign0
sqrt
ln
log
log10
floor
ceil
sin
cos
tan
asin
acos
atan
atan2
CalculateTrajectoryVelocity

Vectors

V2
V3
V4
EV2
EV3
EV4
ToCell
FromCell
Magnitude
SqrMagnitude
Normalize
Cross
Dot
Vector0

Tables

CreateTable
Table
TableN
ClearTable
GetTableElement
SetTableElement
SetTableElementRPN
RemoveTableElement
TableContainsKey
GetTableKeys
GetTableValues
GetTableCount
GetGlobalTable
SetGlobalTable

Lists

CreateList
List
ListN
CreateListStartingSize
GetListElement
SetListElement
SetListElementRPN
InsertListElement
ClearList
ListContains
GetListIndex
GetListIndices
GetListCount
AppendToList
PushList
AppendStackToList
AppendListToList
PrependToList
PrependStackToList
PrependListToList
PopList
RemoveListElement
ReverseList
ListToStack
StringToList
GetGlobalList
(Missing SetGlobalList ?)

Timers

ElapsedTime
GetTimer0
GetTimer1
GetTimer2
GetTimer3
SetTimer0
SetTimer1
SetTimer2
SetTimer3
SetTimerObeyPause0
SetTimerObeyPause1
SetTimerObeyPause2
SetTimerObeyPause3

Creeper

GetCreeper
SetCreeper
AddCreeper
DamageCreeper
GetCreeperInArea
SetCreeperInArea
GetCreeperOnLine
GetCreeperTotal
GetAcTotal
GetDeepestCreeper
GetNearestCreeper
ConvertAcToCreeper
ConvertCreeperToAc
SetCreeperGravity
SetCreeperMin
SetCreeperGlobalGrowth
GetOverAc
GetOverCreeper

Sands & Sand Particles

GetSand
CreateSand
IsSandEmpty
GetSandInArea
CountSandInArea
CreateSandInArea
CreateSandInAreaRand
CreateSandInRoundArea
DestroySandInArea
GetMapSandCount
DestroySandFromList
TerpLocation
SetSandColor
GetSandDef
GetSandDefData
GetOverSand
GetSandParticle
CreateSandParticle
GetSandParticleCountInRange
HasSandParticle

Fields

CreateFc
GetFc
DestroyFc
GetFcCell
SetFcCell
FillFcIsland
FillFcLinear
FillFcPin
FillFcRadial
SetFcPosition
DeployFc
SetFcVisible
SetFcApplyAc
SetFcApplyCreeper
SetFcIsPin
GetFcs
SetFcSave

Mission

GetPause
SetPause
GetEditMode
GetCategory
GetFreeBuild
GetSlammer
QuickSave
QuickLoad
AwardMissionComplete
MissionLoss
GetMissionRequirementsMet
GetMissionCompletionDialogOpen
SetSuppressApexJump
SetMissionCompletionDialogSuppressed
GetReturningToOrbit
Jump

Game Settings

GetGameTickCount
GetGameUpdateCount
TerpPaintingEnabled
GetShieldsEnabled
SetShieldsEnabled
GetDigitalis
SetDigitalis
GetUpgradeBoost
SetUpgradeBoost
UseLegalUnitCells
SetLegalUnitCells
SetLegalUnitCellsRect
ClearLegalUnitCells
IsPassable

Default UI

ShowUiIndicator
ShowInfoArea
GetHelpOpen
SetHelpOpen
GetPositionHelpButton
ShowInventory
GetPositionInventoryButton
ShowResourceArea
GetPositionPauseControl
GetTerpControlsOpen
SetTerpControlsOpen
GetPositionTerpControls

User Input

GetKey
GetKeyDown
GetMappedKey
GetMappedKeyDown
GetMappedKeyStrings
GetMouseButton
GetMouseButtonDown
GetMouseButtonUp
GetMouseCell
GetMousePixel
GetMousePos
PixelToPos
PosToPixel

UI

CreateUI
DestroyUI
GetUIExists
SetUIActive
SetUIBackgroundColor
SetUiColor
SetUiPosition
SetUiSize
SetUIText

Camera

SetMoveMapManualMode
GetCameraPosition
SetCameraPosition
GetCameraZoom
SetCameraZoom
GetScreenSize
GetZoomForWidth
FlashScreen

Pop-up Messages

CloseBubbleMessage
CloseGameMessage
GetConversationOpen
GetGameMessageOpen
ShowBubbleMessage
ShowBubbleMessage_Sound
ShowConversation
ShowGameMessage
ShowUiHelp

Sprites

CreateSprite
DestroySprite
SetSpriteActive
SetSpriteAlpha
SetSpriteColor
SetSpriteScale
SetSpriteLayer
SetSpriteOrder
SetSpriteParent
SetSpritePosition
SetSpriteRotation

Beams

CreateBeam
DestroyBeam
BeamExists
SetBeamEnabled
SetBeamStart
SetBeamEnd
SetBeamColor
SetBeamWidth
SetBeamAutoDisable
SetBeamCapVertices

Effects

CreateEffect
CreateSandExplosion

Sounds

PlaySound
PlaySoundLoop
SetSoundLoopPitch
StopSoundLoop

Unit Manipulation

CreateUnit
Destroy
GetAmmo
SetAmmo
ConsumeAmmo
GetMaxAmmo
SetMaxAmmo

Location

GetPosition
SetPosition
GetRotation
SetRotation
MoveUnit
MoveRotation
GetUnitDirection
SetUnitDirection
RotateUnitTowards
GetLocalPosition
SetLocalPosition
GetLocalRotation
SetLocalRotation
TransformPoint

Part Data

GetActive
SetActive
GetName
GetDestroyed
GetPartData
SetColor
IsDestroyActionEnabled
GetUnitBuild
SetUnitBuild
GetUnitAmmoSupply
SetUnitAmmoSupply
GetPixelCount
GetAllPixelCount
GetOnBoardComplete
GetRandPixelDataPos
GetPowerGeneration
GetTotalPowerGeneration
GetUnitUpdateCount

Physics

AddPhysicsForce
GetPhysicsVelocity
SetPhysicsVelocity

Finding Units

Self
GetApex
GetChild
GetChildren
GetParent
GetUnitsByName
GetUnitsInRange
GetNullifiableUnitsInRange
GetSelectedUnits
HasSelectedUnit
GetShotHitUnitsInRange

Unit Parameters

GetControllerArg
SetControllerArg
GetControllerArg2
SetControllerArg2
GetScriptVar
SetScriptVar
GetScript1Var
SetScript1Var
GetRegisteredScriptVar
SetRegisteredScriptVar

Range Indicator

GetShowRange
SetShowRange
GetShowRangeColor
SetShowRangeColor

LOS

EnableLos
GetLos
GetLosRange
SetLosRange
GetLosSandPassBits
SetLosSandPassBits
CreateShot
GetFowRange
SetFowRange

Rockets

EnableRa
GetRaRange
SetRaRange
GetRaPath
CreateRaRocket

Terp

EnableTerpScan
GetTerpScanRange
SetTerpScanRange
GetTerpScanResult
GetTerpScanHarvestResult
SetHarvestSandDef

Particulate

CreateParticulate
DamageParticulate
EnableParticulateScan
GetParticulateScanRange
SetParticulateScanRange
GetParticulateScanResult
CreateParticulateShot

Internal Health

GetInternalHealth
SetInternalHealth
DamageInternalHealth
GetMaxInternalHealth
SetMaxInternalHealth

MCS

GetMcsItem
GetAllMcsKeys
SetMcsItem

Messaging

SendMsg
RegisterForMsg
DeregisterForMsg
RegisterScript
DeregisterScript

Inventory

AddPlanToInventory
ClearInventory
GetInventory
HasInventory
RemovePlanFromInventory