Knuckle Cracker Wiki

User Tools

Site Tools

Trace: • game • xor
playground:fire:irpl_test

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
playground:fire:irpl_test [2025/02/25 11:09] – Game Physics and User IO Fireswampplayground:fire:irpl_test [2025/09/23 21:58] (current) – Replaced Lorem Ipsum text Fireswamp
Line 1: Line 1:
 ====== IRPL Reference ====== ====== IRPL Reference ======
  
-Lorem Ipsum.+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 ===== ===== Programming Logic =====
 +
 +Notation for basic programming concepts and commands for performing mathematical operations on data.
  
 <WRAP group> <WRAP group>
Line 55: Line 57:
 [[ixe:irpl:comparators:lte0|lte0]] \\ [[ixe:irpl:comparators:lte0|lte0]] \\
 </WRAP> </WRAP>
 +</WRAP>
 +
 +<WRAP group>
  
 <WRAP column> <WRAP column>
Line 112: Line 117:
 [[ixe:irpl:stack:clearstack|ClearStack]] \\ [[ixe:irpl:stack:clearstack|ClearStack]] \\
 </WRAP> </WRAP>
 +</WRAP>
 +
 +<WRAP group>
  
 <WRAP column> <WRAP column>
Line 217: Line 225:
 [[ixe:irpl:math:calculatetrajectoryvelocity|CalculateTrajectoryVelocity]] \\ [[ixe:irpl:math:calculatetrajectoryvelocity|CalculateTrajectoryVelocity]] \\
 </WRAP> </WRAP>
 +</WRAP>
 +
 +<WRAP group>
  
 <WRAP column> <WRAP column>
Line 302: Line 313:
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +----
  
 ===== Game Physics ===== ===== Game Physics =====
  
-Lorem Ipsum.+Commands that directly read or affect the game state.
  
 <WRAP group> <WRAP group>
 <WRAP column> <WRAP column>
 ==== Creeper ==== ==== Creeper ====
 +[[ixe:irpl:creeper:getcreeper|GetCreeper]] \\
 +[[ixe:irpl:creeper:setcreeper|SetCreeper]] \\
 [[ixe:irpl:creeper:addcreeper|AddCreeper]] \\ [[ixe:irpl:creeper:addcreeper|AddCreeper]] \\
-[[ixe:irpl:creeper:convertactocreeper|ConvertAcToCreeper]] \\ 
-[[ixe:irpl:creeper:convertcreepertoac|ConvertCreeperToAc]] \\ 
 [[ixe:irpl:creeper:damagecreeper|DamageCreeper]] \\ [[ixe:irpl:creeper:damagecreeper|DamageCreeper]] \\
-[[ixe:irpl:creeper:getactotal|GetAcTotal]] \\ 
-[[ixe:irpl:creeper:getcreeper|GetCreeper]] \\ 
 [[ixe:irpl:creeper:getcreeperinarea|GetCreeperInArea]] \\ [[ixe:irpl:creeper:getcreeperinarea|GetCreeperInArea]] \\
-[[ixe:irpl:creeper:getcreeperonline|GetCreeperOnline]] \\+[[ixe:irpl:creeper:setcreeperinarea|SetCreeperInArea]] \\ 
 +[[ixe:irpl:creeper:getcreeperonline|GetCreeperOnLine]] \\
 [[ixe:irpl:creeper:getcreepertotal|GetCreeperTotal]] \\ [[ixe:irpl:creeper:getcreepertotal|GetCreeperTotal]] \\
 +[[ixe:irpl:creeper:getactotal|GetAcTotal]] \\
 [[ixe:irpl:creeper:getdeepestcreeper|GetDeepestCreeper]] \\ [[ixe:irpl:creeper:getdeepestcreeper|GetDeepestCreeper]] \\
 [[ixe:irpl:creeper:getnearestcreeper|GetNearestCreeper]] \\ [[ixe:irpl:creeper:getnearestcreeper|GetNearestCreeper]] \\
-[[ixe:irpl:creeper:getoverac|GetOverAc]] \\ +[[ixe:irpl:creeper:convertactocreeper|ConvertAcToCreeper]] \\ 
-[[ixe:irpl:creeper:getovercreeper|GetOverCreeper]] \\ +[[ixe:irpl:creeper:convertcreepertoac|ConvertCreeperToAc]] \\
-[[ixe:irpl:creeper:setcreeper|SetCreeper]] \\ +
-[[ixe:irpl:creeper:setcreeperglobalgrowth|SetCreeperGlobalGrowth]] \\+
 [[ixe:irpl:creeper:setcreepergravity|SetCreeperGravity]] \\ [[ixe:irpl:creeper:setcreepergravity|SetCreeperGravity]] \\
-[[ixe:irpl:creeper:setcreeperinarea|SetCreeperInArea]] \\ 
 [[ixe:irpl:creeper:setcreepermin|SetCreeperMin]] \\ [[ixe:irpl:creeper:setcreepermin|SetCreeperMin]] \\
 +[[ixe:irpl:creeper:setcreeperglobalgrowth|SetCreeperGlobalGrowth]] \\
 +[[ixe:irpl:creeper:getoverac|GetOverAc]] \\
 +[[ixe:irpl:creeper:getovercreeper|GetOverCreeper]] \\
 </WRAP> </WRAP>
  
 <WRAP column> <WRAP column>
-==== Sands ==== +==== Sands & Sand Particles ==== 
-[[ixe:irpl:sand:countsandinarea|CountSandInArea]] \\+[[ixe:irpl:sand:getsand|GetSand]] \\
 [[ixe:irpl:sand:createsand|CreateSand]] \\ [[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:createsandinarea|CreateSandInArea]] \\
 [[ixe:irpl:sand:createsandinarearand|CreateSandInAreaRand]] \\ [[ixe:irpl:sand:createsandinarearand|CreateSandInAreaRand]] \\
 [[ixe:irpl:sand:createsandinroundarea|CreateSandInRoundArea]] \\ [[ixe:irpl:sand:createsandinroundarea|CreateSandInRoundArea]] \\
-[[ixe:irpl:sand:destroysandfromlist|DestroySandFromList]] \\ 
 [[ixe:irpl:sand:destroysandinarea|DestroySandInArea]] \\ [[ixe:irpl:sand:destroysandinarea|DestroySandInArea]] \\
 [[ixe:irpl:sand:getmapsandcount|GetMapSandCount]] \\ [[ixe:irpl:sand:getmapsandcount|GetMapSandCount]] \\
-[[ixe:irpl:sand:getoversand|GetOverSand]] \\ +[[ixe:irpl:sand:destroysandfromlist|DestroySandFromList]] \\ 
-[[ixe:irpl:sand:getsand|GetSand]] \\+[[ixe:irpl:sand:terplocation|TerpLocation]] \\ 
 +[[ixe:irpl:sand:setsandcolor|SetSandColor]] \\
 [[ixe:irpl:sand:getsanddef|GetSandDef]] \\ [[ixe:irpl:sand:getsanddef|GetSandDef]] \\
 [[ixe:irpl:sand:getsanddefdata|GetSandDefData]] \\ [[ixe:irpl:sand:getsanddefdata|GetSandDefData]] \\
-[[ixe:irpl:sand:getsandinarea|GetSandInArea]] \\ +[[ixe:irpl:sand:getoversand|GetOverSand]] \\
-[[ixe:irpl:sand:issandempty|IsSandEmpty]] \\ +
-[[ixe:irpl:sand:setsandcolor|SetSandColor]] \\ +
-[[ixe:irpl:sand:terplocation|TerpLocation]] \\ +
- +
-==== SandParticles ==== +
-[[ixe:irpl:sandparticle:createsandparticle|CreateSandParticle]] \\+
 [[ixe:irpl:sandparticle:getsandparticle|GetSandParticle]] \\ [[ixe:irpl:sandparticle:getsandparticle|GetSandParticle]] \\
 +[[ixe:irpl:sandparticle:createsandparticle|CreateSandParticle]] \\
 [[ixe:irpl:sandparticle:getsandparticlecountinrange|GetSandParticleCountInRange]] \\ [[ixe:irpl:sandparticle:getsandparticlecountinrange|GetSandParticleCountInRange]] \\
 [[ixe:irpl:sandparticle:hassandparticle|HasSandParticle]] \\ [[ixe:irpl:sandparticle:hassandparticle|HasSandParticle]] \\
Line 359: Line 370:
 ==== Fields ==== ==== Fields ====
 [[ixe:irpl:fields:createfc|CreateFc]] \\ [[ixe:irpl:fields:createfc|CreateFc]] \\
-[[ixe:irpl:fields:deployfc|DeployFc]] \\+[[ixe:irpl:fields:getfc|GetFc]] \\
 [[ixe:irpl:fields:destroyfc|DestroyFc]] \\ [[ixe:irpl:fields:destroyfc|DestroyFc]] \\
 +[[ixe:irpl:fields:getfccell|GetFcCell]] \\
 +[[ixe:irpl:fields:setfccell|SetFcCell]] \\
 [[ixe:irpl:fields:fillfcisland|FillFcIsland]] \\ [[ixe:irpl:fields:fillfcisland|FillFcIsland]] \\
 [[ixe:irpl:fields:fillfclinear|FillFcLinear]] \\ [[ixe:irpl:fields:fillfclinear|FillFcLinear]] \\
 [[ixe:irpl:fields:fillfcpin|FillFcPin]] \\ [[ixe:irpl:fields:fillfcpin|FillFcPin]] \\
 [[ixe:irpl:fields:fillfcradial|FillFcRadial]] \\ [[ixe:irpl:fields:fillfcradial|FillFcRadial]] \\
-[[ixe:irpl:fields:getfc|GetFc]] \\ +[[ixe:irpl:fields:setfcposition|SetFcPosition]] \\ 
-[[ixe:irpl:fields:getfccell|GetFcCell]] \\ +[[ixe:irpl:fields:deployfc|DeployFc]] \\ 
-[[ixe:irpl:fields:getfcs|GetFcs]] \\+[[ixe:irpl:fields:setfcvisible|SetFcVisible]] \\
 [[ixe:irpl:fields:setfcapplyac|SetFcApplyAc]] \\ [[ixe:irpl:fields:setfcapplyac|SetFcApplyAc]] \\
 [[ixe:irpl:fields:setfcapplycreeper|SetFcApplyCreeper]] \\ [[ixe:irpl:fields:setfcapplycreeper|SetFcApplyCreeper]] \\
-[[ixe:irpl:fields:setfccell|SetFcCell]] \\ 
 [[ixe:irpl:fields:setfcispin|SetFcIsPin]] \\ [[ixe:irpl:fields:setfcispin|SetFcIsPin]] \\
-[[ixe:irpl:fields:setfcposition|SetFcPosition]] \\+[[ixe:irpl:fields:getfcs|GetFcs]] \\
 [[ixe:irpl:fields:setfcsave|SetFcSave]] \\ [[ixe:irpl:fields:setfcsave|SetFcSave]] \\
-[[ixe:irpl:fields:setfcvisible|SetFcVisible]] \\ 
 </WRAP> </WRAP>
 +</WRAP>
 +
 +<WRAP group>
  
 <WRAP column> <WRAP column>
Line 415: Line 429:
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +----
  
 ===== User Input/Output ===== ===== User Input/Output =====
  
-Lorem Ipsum.+Commands that deal with player inputs and/or visuals for indicating things to the player.
  
 <WRAP group> <WRAP group>
Line 477: Line 493:
 [[ixe:irpl:game:flashscreen|FlashScreen]] \\ [[ixe:irpl:game:flashscreen|FlashScreen]] \\
 </WRAP> </WRAP>
 +</WRAP>
 +
 +<WRAP group>
  
 <WRAP column> <WRAP column>
Line 532: Line 551:
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +----
  
 ===== Units ===== ===== Units =====
  
-Lorem Ipsum.+Commands that directly read or affect parameters of in game units.
  
 <WRAP group> <WRAP group>
 <WRAP column> <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]] \\ 
 + 
 +==== 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]] \\ 
 + 
 +==== 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:getterpscanrange|GetTerpScanRange]] \\ 
 +[[ixe:irpl:unit:setterpscanrange|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>
 </WRAP> </WRAP>
playground/fire/irpl_test.1740481767.txt.gz · Last modified: 2025/02/25 11:09 by Fireswamp

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki