Knuckle Cracker Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== IRPL Reference ======

The syntax for IRPL is similar to the language syntax from previous games. For a tutorial, see [[4rpl:overview | 4RPL Overview]].  For details on how to create custom units with these scripts, see [[ixe:mapmaking:custom|Making Custom Units page]].

===== Programming Logic =====

Notation for basic programming concepts and commands for performing mathematical operations on data.

<WRAP group>
<WRAP column>
==== Variables ====

[[ixe:irpl:variables:define2|$$Init_var (define hidden)]] \\
[[ixe:irpl:variables:define|$init_var (define)]] \\
[[ixe:irpl:variables:refdelete|--! (RefDelete)]] \\
[[ixe:irpl:variables:delete|--varname (Delete)]] \\
[[ixe:irpl:variables:refwrite|->! (RefWrite)]] \\
[[ixe:irpl:variables:write|->varname (Write)]] \\
[[ixe:irpl:variables:refexists|-?! (RefExists)]] \\
[[ixe:irpl:variables:exists|-?varname (Exists)]] \\
[[ixe:irpl:variables:refread|<-! (Refread)]] \\
[[ixe:irpl:variables:read|<-Varname (Read)]] \\
[[ixe:irpl:variables:clearglobals|ClearGlobals]] \\
[[ixe:irpl:variables:clearlocals|ClearLocals]] \\
[[ixe:irpl:variables:copy|Copy]] \\
[[ixe:irpl:variables:deepcopy|DeepCopy]] \\
</WRAP>

<WRAP column>
==== Functions ====
[[ixe:irpl:functions:call|call]] \\
[[ixe:irpl:functions:func|func]] \\
[[ixe:irpl:functions:refcall|refcall]] \\

==== Logic ====
[[ixe:irpl:logic:not|not]] \\
[[ixe:irpl:logic:and|and]] \\
[[ixe:irpl:logic:or|or]] \\
[[ixe:irpl:logic:xor|xor]] \\
[[ixe:irpl:logic:true|true]] \\
[[ixe:irpl:logic:false|false]] \\
</WRAP>

<WRAP column>
==== Comparators ====
[[ixe:irpl:comparators:eq|eq]] \\
[[ixe:irpl:comparators:eq0|eq0]] \\
[[ixe:irpl:comparators:neq|neq]] \\
[[ixe:irpl:comparators:neq0|neq0]] \\
[[ixe:irpl:comparators:gt|gt]] \\
[[ixe:irpl:comparators:gt0|gt0]] \\
[[ixe:irpl:comparators:gte|gte]] \\
[[ixe:irpl:comparators:gte0|gte0]] \\
[[ixe:irpl:comparators:lt|lt]] \\
[[ixe:irpl:comparators:lt0|lt0]] \\
[[ixe:irpl:comparators:lte|lte]] \\
[[ixe:irpl:comparators:lte0|lte0]] \\
</WRAP>
</WRAP>

<WRAP group>

<WRAP column>
==== Constants ====
[[ixe:irpl:constants:e|e]] \\
[[ixe:irpl:constants:pi|Pi]] \\
[[ixe:irpl:constants:quarterpi|QuarterPi]] \\
[[ixe:irpl:constants:halfpi|HalfPi]] \\
[[ixe:irpl:constants:threequarterpi|ThreeQuarterPi]] \\
[[ixe:irpl:constants:threehalvespi|ThreeHalvesPi]] \\
[[ixe:irpl:constants:twopi|TwoPi]] \\
[[ixe:irpl:constants:tau|Tau]] \\
[[ixe:irpl:constants:deg2rad|Deg2Rad]] \\
[[ixe:irpl:constants:rad2deg|Rad2Deg]] \\
[[ixe:irpl:constants:vector0|Vector0]] \\
[[ixe:irpl:math:maxint|MaxInt]] \\
[[ixe:irpl:math:minint|MinInt]] \\
</WRAP>

<WRAP column>
==== Strings ====
[[ixe:irpl:strings:concat|Concat]] \\
[[ixe:irpl:strings:concat3|Concat3]] \\
[[ixe:irpl:strings:concat4|Concat4]] \\
[[ixe:irpl:strings:tab|TAB]] \\
[[ixe:irpl:strings:lf|LF (Line Feed)]] \\
[[ixe:irpl:strings:cr|CR (Carriage Return)]] \\
[[ixe:irpl:strings:dq|DQ (Double Quote)]] \\
[[ixe:irpl:strings:gettimestring|GetTimeString]] \\
[[ixe:irpl:strings:startswith|StartsWith]] \\
[[ixe:irpl:strings:endswith|EndsWith]] \\
[[ixe:irpl:strings:stringlength|StringLength]] \\
[[ixe:irpl:strings:stringtolist|StringToList]] \\
[[ixe:irpl:strings:stringreplace|StringReplace]] \\
[[ixe:irpl:strings:substring|Substring]] \\
[[ixe:irpl:strings:split|Split]] \\
[[ixe:irpl:strings:removewhitespace|RemoveWhiteSpace]] \\
[[ixe:irpl:strings:tolower|ToLower]] \\
[[ixe:irpl:strings:toupper|ToUpper]] \\
</WRAP>

<WRAP column>
==== Data Type Manipulation ====
[[ixe:irpl:data:asint|asint]] \\
[[ixe:irpl:data:asfloat|asfloat]] \\
[[ixe:irpl:data:asstring|asstring]] \\
[[ixe:irpl:data:gettype|GetType]] \\
[[ixe:irpl:data:null|NULL]] \\
[[ixe:irpl:data:isnull|IsNull]] \\

==== Stack Manipulation ====
[[ixe:irpl:stack:dup|dup]] \\
[[ixe:irpl:stack:dup2|dup2]] \\
[[ixe:irpl:stack:pop|pop]] \\
[[ixe:irpl:stack:swap|swap]] \\
[[ixe:irpl:stack:clearstacksize|StackSize]] \\
[[ixe:irpl:stack:clearstack|ClearStack]] \\
</WRAP>
</WRAP>

<WRAP group>

<WRAP column>
==== Debugging ====
[[ixe:irpl:debugging:debug|Debug]] \\
[[ixe:irpl:debugging:debugallsp|DebugAllSp]] \\
[[ixe:irpl:debugging:print|Print]] \\
[[ixe:irpl:debugging:print2|Print2]] \\
[[ixe:irpl:debugging:print3|Print3]] \\
[[ixe:irpl:debugging:print4|Print4]] \\
[[ixe:irpl:debugging:print5|Print5]] \\
[[ixe:irpl:debugging:printall|PrintAll]] \\
[[ixe:irpl:debugging:printallsp|PrintAllSp]] \\
[[ixe:irpl:debugging:printstack|PrintStack]] \\
[[ixe:irpl:debugging:getprintprefixenabled|GetPrintPrefixEnabled]] \\
[[ixe:irpl:debugging:setprintprefixenabled|SetPrintPrefixEnabled]] \\
[[ixe:irpl:debugging:clearprintlog|ClearPrintLog]] \\
[[ixe:irpl:debugging:trace|Trace]] \\
[[ixe:irpl:debugging:trace2|Trace2]] \\
[[ixe:irpl:debugging:trace3|Trace3]] \\
[[ixe:irpl:debugging:trace4|Trace4]] \\
[[ixe:irpl:debugging:trace5|Trace5]] \\
[[ixe:irpl:debugging:traceall|TraceAll]] \\
[[ixe:irpl:debugging:traceallsp|TraceAllSp]] \\
[[ixe:irpl:debugging:tracestack|TraceStack]] \\
[[ixe:irpl:debugging:cleartracelog|ClearTraceLog]] \\
</WRAP>

<WRAP column>
==== Flow Control ====
[[ixe:irpl:flow_control:if|if]] \\
[[ixe:irpl:flow_control:endif|endif]] \\
[[ixe:irpl:flow_control:else|else]] \\
[[ixe:irpl:flow_control:once|once]] \\
[[ixe:irpl:flow_control:endonce|endonce]] \\
[[ixe:irpl:flow_control:do|do]] \\
[[ixe:irpl:flow_control:loop|loop]] \\
[[ixe:irpl:flow_control:i|i]] \\
[[ixe:irpl:flow_control:j|j]] \\
[[ixe:irpl:flow_control:k|k]] \\
[[ixe:irpl:flow_control:break|break]] \\
[[ixe:irpl:flow_control:while|while]] \\
[[ixe:irpl:flow_control:endwhile|endwhile]] \\
[[ixe:irpl:flow_control:repeat|repeat]] \\
[[ixe:irpl:flow_control:switch|switch]] \\
[[ixe:irpl:flow_control:endswitch|endswitch]] \\
[[ixe:irpl:flow_control:case|case]] \\
[[ixe:irpl:flow_control:endcase|endcase]] \\
[[ixe:irpl:flow_control:return|return]] \\
</WRAP>

<WRAP column>
==== Arithmetic ====
[[ixe:irpl:arithmetic:add|add]] \\
[[ixe:irpl:arithmetic:sub|sub]] \\
[[ixe:irpl:arithmetic:mul|mul]] \\
[[ixe:irpl:arithmetic:div|div]] \\
[[ixe:irpl:arithmetic:pow|pow]] \\
[[ixe:irpl:arithmetic:mod|mod]] \\
[[ixe:irpl:arithmetic:mod2|mod2]] \\

==== Math Utility ====
[[ixe:irpl:math_utility:randint|randint]] \\
[[ixe:irpl:math_utility:randfloat|randfloat]] \\
[[ixe:irpl:math_utility:clamp|clamp]] \\
[[ixe:irpl:math_utility:clamp01|clamp01]] \\
[[ixe:irpl:math_utility:pingpong|pingpong]] \\
[[ixe:irpl:math_utility:signalgenerator|signalgenerator]] \\
[[ixe:irpl:math_utility:numrepeat|numrepeat]] \\
[[ixe:irpl:math_utility:movetowards|movetowards]] \\
[[ixe:irpl:math_utility:rotatetowards|rotatetowards]] \\
[[ixe:irpl:math_utility:rotatetowardscell|rotatetowardscell]] \\
[[ixe:irpl:math_utility:distance|distance]] \\
[[ixe:irpl:math_utility:distancecell|distancecell]] \\
[[ixe:irpl:math_utility:distancepointline|distancepointline]] \\
[[ixe:irpl:math_utility:shortestangle|shortestangle]] \\
[[ixe:irpl:math_utility:vectorangle|vectorangle]] \\
[[ixe:irpl:math_utility:vectoranglecell|vectoranglecell]] \\
</WRAP>

<WRAP column>
==== Math ====
[[ixe:irpl:math:round|round]] \\
[[ixe:irpl:math:approximately|approximately]] \\
[[ixe:irpl:math:max|max]] \\
[[ixe:irpl:math:min|min]] \\
[[ixe:irpl:math:avg2|avg2]] \\
[[ixe:irpl:math:neg|neg]] \\
[[ixe:irpl:math:abs|abs]] \\
[[ixe:irpl:math:sign|sign]] \\
[[ixe:irpl:math:sign0|sign0]] \\
[[ixe:irpl:math:sqrt|sqrt]] \\
[[ixe:irpl:math:ln|ln]] \\
[[ixe:irpl:math:log|log]] \\
[[ixe:irpl:math:log10|log10]] \\
[[ixe:irpl:math:floor|floor]] \\
[[ixe:irpl:math:ceil|ceil]] \\
[[ixe:irpl:math:sin|sin]] \\
[[ixe:irpl:math:cos|cos]] \\
[[ixe:irpl:math:tan|tan]] \\
[[ixe:irpl:math:asin|asin]] \\
[[ixe:irpl:math:acos|acos]] \\
[[ixe:irpl:math:atan|atan]] \\
[[ixe:irpl:math:atan2|atan2]] \\
[[ixe:irpl:math:calculatetrajectoryvelocity|CalculateTrajectoryVelocity]] \\
</WRAP>
</WRAP>

<WRAP group>

<WRAP column>
==== Vectors ====
[[ixe:irpl:vectors:v2|V2]] \\
[[ixe:irpl:vectors:v3|V3]] \\
[[ixe:irpl:vectors:v4|V4]] \\
[[ixe:irpl:vectors:ev2|EV2]] \\
[[ixe:irpl:vectors:ev3|EV3]] \\
[[ixe:irpl:vectors:ev4|EV4]] \\
[[ixe:irpl:vectors:tocell|ToCell]] \\
[[ixe:irpl:vectors:fromcell|FromCell]] \\
[[ixe:irpl:vectors:magnitude|Magnitude]] \\
[[ixe:irpl:vectors:sqrmagnitude|SqrMagnitude]] \\
[[ixe:irpl:vectors:normalize|Normalize]] \\
[[ixe:irpl:vectors:cross|Cross]] \\
[[ixe:irpl:vectors:dot|Dot]] \\
[[ixe:irpl:constants:vector0|Vector0]] \\
</WRAP>

<WRAP column>
==== Tables ====
[[ixe:irpl:tables:createtable|CreateTable]] \\
[[ixe:irpl:tables:table|Table]] \\
[[ixe:irpl:tables:tablen|TableN]] \\
[[ixe:irpl:tables:cleartable|ClearTable]] \\
[[ixe:irpl:tables:gettableelement|GetTableElement]] \\
[[ixe:irpl:tables:settableelement|SetTableElement]] \\
[[ixe:irpl:tables:settableelementrpn|SetTableElementRPN]] \\
[[ixe:irpl:tables:removetableelement|RemoveTableElement]] \\
[[ixe:irpl:tables:tablecontainskey|TableContainsKey]] \\
[[ixe:irpl:tables:gettablekeys|GetTableKeys]] \\
[[ixe:irpl:tables:gettablevalues|GetTableValues]] \\
[[ixe:irpl:tables:gettablecount|GetTableCount]] \\
[[ixe:irpl:tables:getglobaltable|GetGlobalTable]] \\
[[ixe:irpl:tables:setglobaltable|SetGlobalTable]] \\
</WRAP>

<WRAP column>
==== Lists ====
[[ixe:irpl:lists:createlist|CreateList]] \\
[[ixe:irpl:lists:list|List]] \\
[[ixe:irpl:lists:listn|ListN]] \\
[[ixe:irpl:lists:createliststartingsize|CreateListStartingSize]] \\
[[ixe:irpl:lists:getlistelement|GetListElement]] \\
[[ixe:irpl:lists:setlistelement|SetListElement]] \\
[[ixe:irpl:lists:setlistelementrpn|SetListElementRPN]] \\
[[ixe:irpl:lists:insertlistelement|InsertListElement]] \\
[[ixe:irpl:lists:clearlist|ClearList]] \\
[[ixe:irpl:lists:listcontains|ListContains]] \\
[[ixe:irpl:lists:getlistindex|GetListIndex]] \\
[[ixe:irpl:lists:getlistindices|GetListIndices]] \\
[[ixe:irpl:lists:getlistcount|GetListCount]] \\
[[ixe:irpl:lists:appendtolist|AppendToList]] \\
[[ixe:irpl:lists:pushlist|PushList]] \\
[[ixe:irpl:lists:appendstacktolist|AppendStackToList]] \\
[[ixe:irpl:lists:appendlisttolist|AppendListToList]] \\
[[ixe:irpl:lists:prependtolist|PrependToList]] \\
[[ixe:irpl:lists:prependstacktolist|PrependStackToList]] \\
[[ixe:irpl:lists:prependlisttolist|PrependListToList]] \\
[[ixe:irpl:lists:poplist|PopList]] \\
[[ixe:irpl:lists:removelistelement|RemoveListElement]] \\
[[ixe:irpl:lists:reverselist|ReverseList]] \\
[[ixe:irpl:lists:listtostack|ListToStack]] \\
[[ixe:irpl:lists:stringtolist|StringToList]] \\
[[ixe:irpl:lists:getgloballist|GetGlobalList]] \\
</WRAP>

<WRAP column>
==== Timers ====
[[ixe:irpl:timers:elapsedtime|ElapsedTime]] \\
[[ixe:irpl:timers:gettimer0|GetTimer0]] \\
[[ixe:irpl:timers:gettimer1|GetTimer1]] \\
[[ixe:irpl:timers:gettimer2|GetTimer2]] \\
[[ixe:irpl:timers:gettimer3|GetTimer3]] \\
[[ixe:irpl:timers:settimer0|SetTimer0]] \\
[[ixe:irpl:timers:settimer1|SetTimer1]] \\
[[ixe:irpl:timers:settimer2|SetTimer2]] \\
[[ixe:irpl:timers:settimer3|SetTimer3]] \\
[[ixe:irpl:timers:settimerobeypause0|SetTimerObeyPause0]] \\
[[ixe:irpl:timers:settimerobeypause1|SetTimerObeyPause1]] \\
[[ixe:irpl:timers:settimerobeypause2|SetTimerObeyPause2]] \\
[[ixe:irpl:timers:settimerobeypause3|SetTimerObeyPause3]] \\
</WRAP>
</WRAP>

----

===== Game Physics =====

Commands that directly read or affect the game state.

<WRAP group>
<WRAP column>
==== Creeper ====
[[ixe:irpl:creeper:getcreeper|GetCreeper]] \\
[[ixe:irpl:creeper:setcreeper|SetCreeper]] \\
[[ixe:irpl:creeper:addcreeper|AddCreeper]] \\
[[ixe:irpl:creeper:damagecreeper|DamageCreeper]] \\
[[ixe:irpl:creeper:getcreeperinarea|GetCreeperInArea]] \\
[[ixe:irpl:creeper:setcreeperinarea|SetCreeperInArea]] \\
[[ixe:irpl:creeper:getcreeperonline|GetCreeperOnLine]] \\
[[ixe:irpl:creeper:getcreepertotal|GetCreeperTotal]] \\
[[ixe:irpl:creeper:getactotal|GetAcTotal]] \\
[[ixe:irpl:creeper:getdeepestcreeper|GetDeepestCreeper]] \\
[[ixe:irpl:creeper:getnearestcreeper|GetNearestCreeper]] \\
[[ixe:irpl:creeper:convertactocreeper|ConvertAcToCreeper]] \\
[[ixe:irpl:creeper:convertcreepertoac|ConvertCreeperToAc]] \\
[[ixe:irpl:creeper:setcreepergravity|SetCreeperGravity]] \\
[[ixe:irpl:creeper:setcreepermin|SetCreeperMin]] \\
[[ixe:irpl:creeper:setcreeperglobalgrowth|SetCreeperGlobalGrowth]] \\
[[ixe:irpl:creeper:getoverac|GetOverAc]] \\
[[ixe:irpl:creeper:getovercreeper|GetOverCreeper]] \\
</WRAP>

<WRAP column>
==== Sands & Sand Particles ====
[[ixe:irpl:sand:getsand|GetSand]] \\
[[ixe:irpl:sand:createsand|CreateSand]] \\
[[ixe:irpl:sand:issandempty|IsSandEmpty]] \\
[[ixe:irpl:sand:getsandinarea|GetSandInArea]] \\
[[ixe:irpl:sand:countsandinarea|CountSandInArea]] \\
[[ixe:irpl:sand:createsandinarea|CreateSandInArea]] \\
[[ixe:irpl:sand:createsandinarearand|CreateSandInAreaRand]] \\
[[ixe:irpl:sand:createsandinroundarea|CreateSandInRoundArea]] \\
[[ixe:irpl:sand:destroysandinarea|DestroySandInArea]] \\
[[ixe:irpl:sand:getmapsandcount|GetMapSandCount]] \\
[[ixe:irpl:sand:destroysandfromlist|DestroySandFromList]] \\
[[ixe:irpl:sand:terplocation|TerpLocation]] \\
[[ixe:irpl:sand:setsandcolor|SetSandColor]] \\
[[ixe:irpl:sand:getsanddef|GetSandDef]] \\
[[ixe:irpl:sand:getsanddefdata|GetSandDefData]] \\
[[ixe:irpl:sand:getoversand|GetOverSand]] \\
[[ixe:irpl:sandparticle:getsandparticle|GetSandParticle]] \\
[[ixe:irpl:sandparticle:createsandparticle|CreateSandParticle]] \\
[[ixe:irpl:sandparticle:getsandparticlecountinrange|GetSandParticleCountInRange]] \\
[[ixe:irpl:sandparticle:hassandparticle|HasSandParticle]] \\
</WRAP>

<WRAP column>
==== Fields ====
[[ixe:irpl:fields:createfc|CreateFc]] \\
[[ixe:irpl:fields:getfc|GetFc]] \\
[[ixe:irpl:fields:destroyfc|DestroyFc]] \\
[[ixe:irpl:fields:getfccell|GetFcCell]] \\
[[ixe:irpl:fields:setfccell|SetFcCell]] \\
[[ixe:irpl:fields:fillfcisland|FillFcIsland]] \\
[[ixe:irpl:fields:fillfclinear|FillFcLinear]] \\
[[ixe:irpl:fields:fillfcpin|FillFcPin]] \\
[[ixe:irpl:fields:fillfcradial|FillFcRadial]] \\
[[ixe:irpl:fields:setfcposition|SetFcPosition]] \\
[[ixe:irpl:fields:deployfc|DeployFc]] \\
[[ixe:irpl:fields:setfcvisible|SetFcVisible]] \\
[[ixe:irpl:fields:setfcapplyac|SetFcApplyAc]] \\
[[ixe:irpl:fields:setfcapplycreeper|SetFcApplyCreeper]] \\
[[ixe:irpl:fields:setfcispin|SetFcIsPin]] \\
[[ixe:irpl:fields:getfcs|GetFcs]] \\
[[ixe:irpl:fields:setfcsave|SetFcSave]] \\
</WRAP>
</WRAP>

<WRAP group>

<WRAP column>
==== Mission ====
[[ixe:irpl:game:getpause|GetPause]] \\
[[ixe:irpl:game:setpause|SetPause]] \\
[[ixe:irpl:game:geteditmode|GetEditMode]] \\
[[ixe:irpl:game:getcategory|GetCategory]] \\
[[ixe:irpl:game:getfreebuild|GetFreeBuild]] \\
[[ixe:irpl:game:getslammer|GetSlammer]] \\
[[ixe:irpl:game:quicksave|QuickSave]] \\
[[ixe:irpl:game:quickload|QuickLoad]] \\
[[ixe:irpl:game:awardmissioncomplete|AwardMissionComplete]] \\
[[ixe:irpl:game:missionloss|MissionLoss]] \\
[[ixe:irpl:game:getmissionrequirementsmet|GetMissionRequirementsMet]] \\
[[ixe:irpl:game:getmissioncompletiondialogopen|GetMissionCompletionDialogOpen]] \\
[[ixe:irpl:game:setsuppressapexjump|SetSuppressApexJump]] \\
[[ixe:irpl:game:setmissioncompletiondialogsuppressed|SetMissionCompletionDialogSuppressed]] \\
[[ixe:irpl:game:getreturningtoorbit|GetReturningToOrbit]] \\
[[ixe:irpl:game:jump|Jump]] \\
</WRAP>

<WRAP column>
==== Game Settings ====
[[ixe:irpl:game:getgametickcount|GetGameTickCount]] \\
[[ixe:irpl:game:getgameupdatecount|GetGameUpdateCount]] \\
[[ixe:irpl:game:terppaintingenabled|TerpPaintingEnabled]] \\
[[ixe:irpl:game:getshieldsenabled|GetShieldsEnabled]] \\
[[ixe:irpl:game:setshieldsenabled|SetShieldsEnabled]] \\
[[ixe:irpl:game:getdigitalis|GetDigitalis]] \\
[[ixe:irpl:game:setdigitalis|SetDigitalis]] \\
[[ixe:irpl:game:getupgradeboost|GetUpgradeBoost]] \\
[[ixe:irpl:game:setupgradeboost|SetUpgradeBoost]] \\
[[ixe:irpl:game:uselegalunitcells|UseLegalUnitCells]] \\
[[ixe:irpl:game:setlegalunitcells|SetLegalUnitCells]] \\
[[ixe:irpl:game:setlegalunitcellsrect|SetLegalUnitCellsRect]] \\
[[ixe:irpl:game:clearlegalunitcells|ClearLegalUnitCells]] \\
[[ixe:irpl:game:ispassable|IsPassable]] \\
</WRAP>
</WRAP>

----

===== User Input/Output =====

Commands that deal with player inputs and/or visuals for indicating things to the player.

<WRAP group>
<WRAP column>
==== Default UI ====
[[ixe:irpl:game:showuiindicator|ShowUiIndicator]] \\
[[ixe:irpl:game:showinfoarea|ShowInfoArea]] \\
[[ixe:irpl:game:gethelpopen|GetHelpOpen]] \\
[[ixe:irpl:game:sethelpopen|SetHelpOpen]] \\
[[ixe:irpl:game:getpositionhelpbutton|GetPositionHelpButton]] \\
[[ixe:irpl:game:showinventory|ShowInventory]] \\
[[ixe:irpl:game:getpositioninventorybutton|GetPositionInventoryButton]] \\
[[ixe:irpl:game:showresourcearea|ShowResourceArea]] \\
[[ixe:irpl:game:getpositionpausecontrol|GetPositionPauseControl]] \\
[[ixe:irpl:game:getterpcontrolsopen|GetTerpControlsOpen]] \\
[[ixe:irpl:game:setterpcontrolsopen|SetTerpControlsOpen]] \\
[[ixe:irpl:game:getpositionterpcontrols|GetPositionTerpControls]] \\
</WRAP>
<WRAP column>
==== User Input ====
[[ixe:irpl:io:getkey|GetKey]] \\
[[ixe:irpl:io:getkeydown|GetKeyDown]] \\
[[ixe:irpl:io:getmappedkey|GetMappedKey]] \\
[[ixe:irpl:io:getmappedkeydown|GetMappedKeyDown]] \\
[[ixe:irpl:io:getmappedkeystrings|GetMappedKeyStrings]] \\
[[ixe:irpl:io:getmousebutton|GetMouseButton]] \\
[[ixe:irpl:io:getmousebuttondown|GetMouseButtonDown]] \\
[[ixe:irpl:io:getmousebuttonup|GetMouseButtonUp]] \\
[[ixe:irpl:io:getmousecell|GetMouseCell]] \\
[[ixe:irpl:io:getmousepixel|GetMousePixel]] \\
[[ixe:irpl:io:getmousepos|GetMousePos]] \\
[[ixe:irpl:io:pixeltopos|PixelToPos]] \\
[[ixe:irpl:io:postopixel|PosToPixel]] \\
</WRAP>

<WRAP column>
==== UI ====
[[ixe:irpl:ui:createui|CreateUI]] \\
[[ixe:irpl:ui:destroyui|DestroyUI]] \\
[[ixe:irpl:ui:getuiexists|GetUIExists]] \\
[[ixe:irpl:ui:setuiactive|SetUIActive]] \\
[[ixe:irpl:ui:setuibackgroundcolor|SetUIBackgroundColor]] \\
[[ixe:irpl:ui:setuicolor|SetUIColor]] \\
[[ixe:irpl:ui:setuiposition|SetUIPosition]] \\
[[ixe:irpl:ui:setuisize|SetUISize]] \\
[[ixe:irpl:ui:setuitext|SetUIText]] \\
</WRAP>

<WRAP column>
==== Camera ====
[[ixe:irpl:io:setmovemapmanualmode|SetMoveMapManualMode]] \\
[[ixe:irpl:game:getcameraposition|GetCameraPosition]] \\
[[ixe:irpl:game:setcameraposition|SetCameraPosition]] \\
[[ixe:irpl:game:getcamerazoom|GetCameraZoom]] \\
[[ixe:irpl:game:setcamerazoom|SetCameraZoom]] \\
[[ixe:irpl:game:getscreensize|GetScreenSize]] \\
[[ixe:irpl:game:getzoomforwidth|GetZoomForWidth]] \\
[[ixe:irpl:game:flashscreen|FlashScreen]] \\
</WRAP>
</WRAP>

<WRAP group>

<WRAP column>
==== Pop-up Messages ====
[[ixe:irpl:messaging:closebubblemessage|CloseBubbleMessage]] \\
[[ixe:irpl:messaging:closegamemessage|CloseGameMessage]] \\
[[ixe:irpl:messaging:getconversationopen|GetConversationOpen]] \\
[[ixe:irpl:messaging:getgamemessageopen|GetGameMessageOpen]] \\
[[ixe:irpl:messaging:showbubblemessage|ShowBubbleMessage]] \\
[[ixe:irpl:messaging:showbubblemessage_sound|ShowBubbleMessage_Sound]] \\
[[ixe:irpl:messaging:showconversation|ShowConversation]] \\
[[ixe:irpl:messaging:showgamemessage|ShowGameMessage]] \\
[[ixe:irpl:messaging:showuihelp|ShowUiHelp]] \\
</WRAP>

<WRAP column>
==== Sprites ====
[[ixe:irpl:sprites:createsprite|CreateSprite]] \\
[[ixe:irpl:sprites:destroysprite|DestroySprite]] \\
[[ixe:irpl:sprites:setspriteactive|SetSpriteActive]] \\
[[ixe:irpl:sprites:setspritealpha|SetSpriteAlpha]] \\
[[ixe:irpl:sprites:setspritecolor|SetSpriteColor]] \\
[[ixe:irpl:sprites:setspritescale|SetSpriteScale]] \\
[[ixe:irpl:sprites:setspritelayer|SetSpriteLayer]] \\
[[ixe:irpl:sprites:setspriteorder|SetSpriteOrder]] \\
[[ixe:irpl:sprites:setspriteparent|SetSpriteParent]] \\
[[ixe:irpl:sprites:setspriteposition|SetSpritePosition]] \\
[[ixe:irpl:sprites:setspriterotation|SetSpriteRotation]] \\
</WRAP>

<WRAP column>
==== Beams ====
[[ixe:irpl:beams:createbeam|CreateBeam]] \\
[[ixe:irpl:beams:destroybeam|DestroyBeam]] \\
[[ixe:irpl:beams:beamexists|BeamExists]] \\
[[ixe:irpl:beams:setbeamenabled|SetBeamEnabled]] \\
[[ixe:irpl:beams:setbeamstart|SetBeamStart]] \\
[[ixe:irpl:beams:setbeamend|SetBeamEnd]] \\
[[ixe:irpl:beams:setbeamcolor|SetBeamColor]] \\
[[ixe:irpl:beams:setbeamwidth|SetBeamWidth]] \\
[[ixe:irpl:beams:setbeamautodisable|SetBeamAutoDisable]] \\
[[ixe:irpl:beams:setbeamcapvertices|SetBeamCapVertices]] \\
</WRAP>

<WRAP column>
==== Effects ====
[[ixe:irpl:effects:createeffect|CreateEffect]] \\
[[ixe:irpl:effects:createsandexplosion|CreateSandExplosion]] \\

==== Sounds ====
[[ixe:irpl:sound:playsound|PlaySound]] \\
[[ixe:irpl:sound:playsoundloop|PlaySoundLoop]] \\
[[ixe:irpl:sound:setsoundlooppitch|SetSoundLoopPitch]] \\
[[ixe:irpl:sound:stopsoundloop|StopSoundLoop]] \\
</WRAP>
</WRAP>

----

===== Units =====

Commands that directly read or affect parameters of in game units.

<WRAP group>
<WRAP column>
==== Unit Manipulation ====
[[ixe:irpl:unit:createunit|CreateUnit]] \\
[[ixe:irpl:unit:destroy|Destroy]] \\
[[ixe:irpl:unit:getammo|GetAmmo]] \\
[[ixe:irpl:unit:setammo|SetAmmo]] \\
[[ixe:irpl:unit:consumeammo|ConsumeAmmo]] \\
[[ixe:irpl:unit:getmaxammo|GetMaxAmmo]] \\
[[ixe:irpl:unit:setmaxammo|SetMaxAmmo]] \\
[[ixe:irpl:unit:getunitproperty|GetUnitProperty]] \\
[[ixe:irpl:unit:setunitproperty|SetUnitProperty]] \\

==== Location ====
[[ixe:irpl:unit:getposition|GetPosition]] \\
[[ixe:irpl:unit:setposition|SetPosition]] \\
[[ixe:irpl:unit:getrotation|GetRotation]] \\
[[ixe:irpl:unit:setrotation|SetRotation]] \\
[[ixe:irpl:unit:moveunit|MoveUnit]] \\
[[ixe:irpl:unit:moverotation|MoveRotation]] \\
[[ixe:irpl:unit:getunitdirection|GetUnitDirection]] \\
[[ixe:irpl:unit:setunitdirection|SetUnitDirection]] \\
[[ixe:irpl:unit:rotateunittowards|RotateUnitTowards]] \\
[[ixe:irpl:unit:getlocalposition|GetLocalPosition]] \\
[[ixe:irpl:unit:setlocalposition|SetLocalPosition]] \\
[[ixe:irpl:unit:getlocalrotation|GetLocalRotation]] \\
[[ixe:irpl:unit:setlocalrotation|SetLocalRotation]] \\
[[ixe:irpl:unit:transformpoint|TransformPoint]] \\
</WRAP>

<WRAP column>
==== Part Data ====
[[ixe:irpl:unit:getactive|GetActive]] \\
[[ixe:irpl:unit:setactive|SetActive]] \\
[[ixe:irpl:unit:getname|GetName]] \\
[[ixe:irpl:unit:getdestroyed|GetDestroyed]] \\
[[ixe:irpl:unit:getpartdata|GetPartData]] \\
[[ixe:irpl:unit:setcolor|SetColor]] \\
[[ixe:irpl:unit:isdestroyactionenabled|IsDestroyActionEnabled]] \\
[[ixe:irpl:unit:getunitbuild|GetUnitBuild]] \\
[[ixe:irpl:unit:setunitbuild|SetUnitBuild]] \\
[[ixe:irpl:unit:getunitammosupply|GetUnitAmmoSupply]] \\
[[ixe:irpl:unit:setunitammosupply|SetUnitAmmoSupply]] \\
[[ixe:irpl:unit:getpixelcount|GetPixelCount]] \\
[[ixe:irpl:unit:getallpixelcount|GetAllPixelCount]] \\
[[ixe:irpl:unit:getonboardcomplete|GetOnBoardComplete]] \\
[[ixe:irpl:unit:getrandpixeldatapos|GetRandPixelDataPos]] \\
[[ixe:irpl:unit:getpowergeneration|GetPowerGeneration]] \\
[[ixe:irpl:unit:gettotalpowergeneration|GetTotalPowerGeneration]] \\
[[ixe:irpl:unit:getunitupdatecount|GetUnitUpdateCount]] \\
[[ixe:irpl:unit:getpartproperty|GetPartProperty]] \\
[[ixe:irpl:unit:setpartproperty|SetPartProperty]] \\

==== Physics ====
[[ixe:irpl:unit:addphysicsforce|AddPhysicsForce]] \\
[[ixe:irpl:unit:getphysicsvelocity|GetPhysicsVelocity]] \\
[[ixe:irpl:unit:setphysicsvelocity|SetPhysicsVelocity]] \\
</WRAP>

<WRAP column>
==== Finding Units ====
[[ixe:irpl:unit:self|Self]] \\
[[ixe:irpl:game:getapex|GetApex]] \\
[[ixe:irpl:unit:getchild|GetChild]] \\
[[ixe:irpl:unit:getchildren|GetChildren]] \\
[[ixe:irpl:unit:getparent|GetParent]] \\
[[ixe:irpl:unit:getunitsbyname|GetUnitsByName]] \\
[[ixe:irpl:unit:getunitsinrange|GetUnitsInRange]] \\
[[ixe:irpl:unit:getnullifiableunitsinrange|GetNullifiableUnitsInRange]] \\
[[ixe:irpl:game:getselectedunits|GetSelectedUnits]] \\
[[ixe:irpl:game:hasselectedunit|HasSelectedUnit]] \\
[[ixe:irpl:unit:getshothitunitsinrange|GetShotHitUnitsInRange]] \\

==== Unit Parameters ====
[[ixe:irpl:unit:getcontrollerarg|GetControllerArg]] \\
[[ixe:irpl:unit:setcontrollerarg|SetControllerArg]] \\
[[ixe:irpl:unit:getcontrollerarg2|GetControllerArg2]] \\
[[ixe:irpl:unit:setcontrollerarg2|SetControllerArg2]] \\
[[ixe:irpl:unit:getscriptvar|GetScriptVar]] \\
[[ixe:irpl:unit:setscriptvar|SetScriptVar]] \\
[[ixe:irpl:unit:getscript1var|GetScript1Var]] \\
[[ixe:irpl:unit:setscript1var|SetScript1Var]] \\
[[ixe:irpl:unit:getregisteredscriptvar|GetRegisteredScriptVar]] \\
[[ixe:irpl:unit:setregisteredscriptvar|SetRegisteredScriptVar]] \\
</WRAP>
</WRAP>

<WRAP group>
<WRAP column>
==== Range Indicator ====
[[ixe:irpl:unit:getshowrange|GetShowRange]] \\
[[ixe:irpl:unit:setshowrange|SetShowRange]] \\
[[ixe:irpl:unit:getshowrangecolor|GetShowRangeColor]] \\
[[ixe:irpl:unit:setshowrangecolor|SetShowRangeColor]] \\

==== LOS ====
[[ixe:irpl:unit:enablelos|EnableLos]] \\
[[ixe:irpl:unit:getlos|GetLos]] \\
[[ixe:irpl:unit:getlosrange|GetLosRange]] \\
[[ixe:irpl:unit:setlosrange|SetLosRange]] \\
[[ixe:irpl:unit:getlossandpassbits|GetLosSandPassBits]] \\
[[ixe:irpl:unit:setlossandpassbits|SetLosSandPassBits]] \\
[[ixe:irpl:shots:createshot|CreateShot]] \\
[[ixe:irpl:unit:getfowrange|GetFowRange]] \\
[[ixe:irpl:unit:setfowrange|SetFowRange]] \\
</WRAP>

<WRAP column>
==== Rockets ====
[[ixe:irpl:unit:enablera|EnableRa]] \\
[[ixe:irpl:unit:getrarange|GetRaRange]] \\
[[ixe:irpl:unit:setrarange|SetRaRange]] \\
[[ixe:irpl:unit:getrapath|GetRaPath]] \\
[[ixe:irpl:shots:createrarocket|CreateRaRocket]] \\

==== Terp ====
[[ixe:irpl:unit:enableterpscan|EnableTerpScan]] \\
[[ixe:irpl:unit:geterpscanrange|GetTerpScanRange]] \\
[[ixe:irpl:unit:seterpscanrange|SetTerpScanRange]] \\
[[ixe:irpl:unit:getterpscanresult|GetTerpScanResult]] \\
[[ixe:irpl:unit:getterpscanharvestresult|GetTerpScanHarvestResult]] \\
[[ixe:irpl:unit:setharvestsanddef|SetHarvestSandDef]] \\
</WRAP>

<WRAP column>
==== Particulate ====
[[ixe:irpl:game:createparticulate|CreateParticulate]] \\
[[ixe:irpl:game:damageparticulate|DamageParticulate]] \\
[[ixe:irpl:unit:enableparticulatescan|EnableParticulateScan]] \\
[[ixe:irpl:unit:getparticulatescanrange|GetParticulateScanRange]] \\
[[ixe:irpl:unit:setparticulatescanrange|SetParticulateScanRange]] \\
[[ixe:irpl:unit:getparticulatescanresult|GetParticulateScanResult]] \\
[[ixe:irpl:shots:createparticulateshot|CreateParticulateShot]] \\

==== Internal Health ====
[[ixe:irpl:unit:getinternalhealth|GetInternalHealth]] \\
[[ixe:irpl:unit:setinternalhealth|SetInternalHealth]] \\
[[ixe:irpl:unit:damageinternalhealth|DamageInternalHealth]] \\
[[ixe:irpl:unit:getmaxinternalhealth|GetMaxInternalHealth]] \\
[[ixe:irpl:unit:setmaxinternalhealth|SetMaxInternalHealth]] \\
</WRAP>
</WRAP>

----

===== Miscellaneous ===== 

<WRAP group>
<WRAP column>
==== MCS ====
[[ixe:irpl:game:getmcsitem|GetMcsItem]] \\
[[ixe:irpl:game:getallmcskeys|GetAllMcsKeys]] \\
[[ixe:irpl:game:setmcsitem|SetMcsItem]] \\
</WRAP>

<WRAP column>
==== Messaging ====
[[ixe:irpl:unit:sendmsg|SendMsg]] \\
[[ixe:irpl:unit:registerformsg|RegisterForMsg]] \\
[[ixe:irpl:unit:deregisterformsg|DeregisterForMsg]] \\
[[ixe:irpl:unit:registerscript|RegisterScript]] \\
[[ixe:irpl:unit:deregisterscript|DeregisterScript]] \\
</WRAP>

<WRAP column>
==== Inventory ====
[[ixe:irpl:inventory:addplantoinventory|AddPlanToInventory]] \\
[[ixe:irpl:inventory:clearinventory|ClearInventory]] \\
[[ixe:irpl:inventory:getinventory|GetInventory]] \\
[[ixe:irpl:inventory:hasinventory|HasInventory]] \\
[[ixe:irpl:inventory:removeplanfrominventory|RemovePlanFromInventory]] \\
</WRAP>
</WRAP>
Knuckle Cracker Wiki

User Tools

Site Tools

Page Tools
