Differences

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

--- ixe:irpl:start [2025/01/07 23:51] – durikkan
+++ ixe:irpl:start [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ======  IRPL Reference ======
-//Rough dump of all IRPL commands pending correct formatting of this list//
+The syntax for IRPL is similar to the language syntax from previous games. For a tutorial, see [[4rpl:overview | 4RPL Overview]].
-==== Unit ====
+An [[index]] of all commands in IRPL.
- [[ixe:irpl:unit:Self|Self]] \\
- [[ixe:irpl:unit:GetParent|GetParent]] \\
- [[ixe:irpl:unit:GetChildren|GetChildren]] \\
- [[ixe:irpl:unit:GetChild|GetChild]] \\
- [[ixe:irpl:unit:GetName|GetName]] \\
- [[ixe:irpl:unit:GetActive|GetActive]] \\
- [[ixe:irpl:unit:GetDestroyed|GetDestroyed]] \\
- [[ixe:irpl:unit:SetActive|SetActive]] \\
- [[ixe:irpl:unit:GetPosition|GetPosition]] \\
- [[ixe:irpl:unit:GetLocalPosition|GetLocalPosition]] \\
- [[ixe:irpl:unit:GetRotation|GetRotation]] \\
- [[ixe:irpl:unit:GetLocalRotation|GetLocalRotation]] \\
- [[ixe:irpl:unit:SetPosition|SetPosition]] \\
- [[ixe:irpl:unit:SetLocalPosition|SetLocalPosition]] \\
- [[ixe:irpl:unit:SetRotation|SetRotation]] \\
- [[ixe:irpl:unit:MoveRotation|MoveRotation]] \\
- [[ixe:irpl:unit:TransformPoint|TransformPoint]] \\
- [[ixe:irpl:unit:SetLocalRotation|SetLocalRotation]] \\
- [[ixe:irpl:unit:CreateUnit|CreateUnit]] \\
- [[ixe:irpl:unit:MoveUnit|MoveUnit]] \\
- [[ixe:irpl:unit:SetUnitDirection|SetUnitDirection]] \\
- [[ixe:irpl:unit:RotateUnitTowards|RotateUnitTowards]] \\
- [[ixe:irpl:unit:GetUnitUpdateCount|GetUnitUpdateCount]] \\
- [[ixe:irpl:unit:Destroy|Destroy]] \\
- [[ixe:irpl:unit:IsDestroyActionEnabled|IsDestroyActionEnabled]] \\
- [[ixe:irpl:unit:EnableLos|EnableLos]] \\
- [[ixe:irpl:unit:GetLosRange|GetLosRange]] \\
- [[ixe:irpl:unit:SetLosRange|SetLosRange]] \\
- [[ixe:irpl:unit:GetLosSandPassBits|GetLosSandPassBits]] \\
- [[ixe:irpl:unit:SetLosSandPassBits|SetLosSandPassBits]] \\
- [[ixe:irpl:unit:GetLos|GetLos]] \\
- [[ixe:irpl:unit:EnableRa|EnableRa]] \\
- [[ixe:irpl:unit:GetRaRange|GetRaRange]] \\
- [[ixe:irpl:unit:SetRaRange|SetRaRange]] \\
- [[ixe:irpl:unit:GetRaPath|GetRaPath]] \\
- [[ixe:irpl:unit:EnableTerpScan|EnableTerpScan]] \\
- [[ixe:irpl:unit:GetTerpScanResult|GetTerpScanResult]] \\
- [[ixe:irpl:unit:SetHarvestSandDef|SetHarvestSandDef]] \\
- [[ixe:irpl:unit:GetTerpScanHarvestResult|GetTerpScanHarvestResult]] \\
- [[ixe:irpl:unit:GetRandPixelDataPos|GetRandPixelDataPos]] \\
- [[ixe:irpl:unit:GetPartData|GetPartData]] \\
- [[ixe:irpl:unit:DefaultConfig|DefaultConfig]] \\
- [[ixe:irpl:unit:ReadConfig|ReadConfig]] \\
- [[ixe:irpl:unit:WriteConfig|WriteConfig]] \\
- [[ixe:irpl:unit:GetLog|GetLog]] \\
- [[ixe:irpl:unit:GetShowRange|GetShowRange]] \\
- [[ixe:irpl:unit:SetShowRange|SetShowRange]] \\
- [[ixe:irpl:unit:GetShowRangeColor|GetShowRangeColor]] \\
- [[ixe:irpl:unit:SetShowRangeColor|SetShowRangeColor]] \\
- [[ixe:irpl:unit:SetColor|SetColor]] \\
- [[ixe:irpl:unit:GetPhysicsVelocity|GetPhysicsVelocity]] \\
- [[ixe:irpl:unit:SetPhysicsVelocity|SetPhysicsVelocity]] \\
- [[ixe:irpl:unit:AddPhysicsForce|AddPhysicsForce]] \\
- [[ixe:irpl:unit:GetPixelCount|GetPixelCount]] \\
- [[ixe:irpl:unit:GetAllPixelCount|GetAllPixelCount]] \\
- [[ixe:irpl:unit:GetOnBoardComplete|GetOnBoardComplete]] \\
- [[ixe:irpl:unit:GetUnitsByName|GetUnitsByName]] \\
- [[ixe:irpl:unit:GetUnitsInRange|GetUnitsInRange]] \\
- [[ixe:irpl:unit:GetNullifiableUnitsInRange|GetNullifiableUnitsInRange]] \\
- [[ixe:irpl:unit:GetShotHitUnitsInRange|GetShotHitUnitsInRange]] \\
- [[ixe:irpl:unit:GetAmmo|GetAmmo]] \\
- [[ixe:irpl:unit:SetAmmo|SetAmmo]] \\
- [[ixe:irpl:unit:GetMaxAmmo|GetMaxAmmo]]
- [[ixe:irpl:unit:SetMaxAmmo|SetMaxAmmo]] \\
- [[ixe:irpl:unit:ConsumeAmmo|ConsumeAmmo]]
- [[ixe:irpl:unit:GetMaxInternalHealth|GetMaxInternalHealth]] \\
- [[ixe:irpl:unit:SetMaxInternalHealth|SetMaxInternalHealth]] \\
- [[ixe:irpl:unit:GetInternalHealth|GetInternalHealth]] \\
- [[ixe:irpl:unit:SetInternalHealth|SetInternalHealth]] \\
- [[ixe:irpl:unit:DamageInternalHealth|DamageInternalHealth]] \\
- [[ixe:irpl:unit:GetFowRange|GetFowRange]] \\
- [[ixe:irpl:unit:SetFowRange|SetFowRange]] \\
- [[ixe:irpl:unit:GetTotalPowerGeneration|GetTotalPowerGeneration]] \\
- [[ixe:irpl:unit:GetPowerGeneration|GetPowerGeneration]] \\
- [[ixe:irpl:unit:RegisterForMsg|RegisterForMsg]] \\
- [[ixe:irpl:unit:DeregisterForMsg|DeregisterForMsg]] \\
- [[ixe:irpl:unit:SendMsg|SendMsg]] \\
- [[ixe:irpl:unit:GetControllerArg|GetControllerArg]] \\
- [[ixe:irpl:unit:SetControllerArg|SetControllerArg]] \\
- [[ixe:irpl:unit:GetScriptVar|GetScriptVar]] \\
- [[ixe:irpl:unit:SetScriptVar|SetScriptVar]] \\
- [[ixe:irpl:unit:GetScript1Var|GetScript1Var]] \\
- [[ixe:irpl:unit:SetScript1Var|SetScript1Var]] \\
- [[ixe:irpl:unit:RegisterScript|RegisterScript]] \\
- [[ixe:irpl:unit:DeregisterScript|DeregisterScript]] \\
- [[ixe:irpl:unit:GetRegisteredScriptVar|GetRegisteredScriptVar]] \\
- [[ixe:irpl:unit:SetRegisteredScriptVar|SetRegisteredScriptVar]]  \\
-==== Creeper ====
-[[ixe:irpl:creeper:GetNearestCreeper|GetNearestCreeper]] \\
-[[ixe:irpl:creeper:GetOverCreeper|GetOverCreeper]] \\
-[[ixe:irpl:creeper:GetOverAc|GetOverAc]] \\
-[[ixe:irpl:creeper:GetCreeperOnline|GetCreeperOnline]] \\
-[[ixe:irpl:creeper:GetDeepestCreeper|GetDeepestCreeper]] \\
-[[ixe:irpl:creeper:GetCreeperInArea|GetCreeperInArea]] \\
-[[ixe:irpl:creeper:GetCreeperTotal|GetCreeperTotal]] \\
-[[ixe:irpl:creeper:GetAcTotal|GetAcTotal]] \\
-[[ixe:irpl:creeper:AddCreeper|AddCreeper]] \\
-[[ixe:irpl:creeper:SetCreeperGravity|SetCreeperGravity]] \\
-[[ixe:irpl:creeper:SetCreeperMin|SetCreeperMin]] \\
-[[ixe:irpl:creeper:SetCreeperGlobalGrowth|SetCreeperGlobalGrowth]] \\
-[[ixe:irpl:creeper:DamageCreeper|DamageCreeper]] \\
-[[ixe:irpl:creeper:ConvertCreeperToAc|ConvertCreeperToAc]]   \\
-[[ixe:irpl:creeper:ConvertAcToCreeper|ConvertAcToCreeper]] \\
-==== SandParticle ====
-[[ixe:irpl:sandparticle:CreateSandParticle|CreateSandParticle]] \\
-[[ixe:irpl:sandparticle:GetSandParticleCountInRange|GetSandParticleCountInRange]] \\
-[[ixe:irpl:sandparticle:GetSandParticle|GetSandParticle]] \\
-[[ixe:irpl:sandparticle:HasSandParticle|HasSandParticle]] \\
-==== Sand ====
-[[ixe:irpl:sand:IsSandEmpty|IsSandEmpty]] \\
-[[ixe:irpl:sand:GetSand|GetSand]] \\
-[[ixe:irpl:sand:CreateSand|CreateSand]] \\
-[[ixe:irpl:sand:CreateSandInRoundArea|CreateSandInRoundArea]] \\
-[[ixe:irpl:sand:CreateSandInAreaRand|CreateSandInAreaRand]] \\
-[[ixe:irpl:sand:CreateSandInArea|CreateSandInArea]] \\
-[[ixe:irpl:sand:GetOverSand|GetOverSand]] \\
-[[ixe:irpl:sand:SetSandColor|SetSandColor]] \\
-[[ixe:irpl:sand:GetSandDef|GetSandDef]] \\
-[[ixe:irpl:sand:GetMapSandCount|GetMapSandCount]] \\
-[[ixe:irpl:sand:CountSandInArea|CountSandInArea]] \\
-[[ixe:irpl:sand:GetSandInArea|GetSandInArea]] \\
-[[ixe:irpl:sand:DestroySandInArea|DestroySandInArea]] \\
-[[ixe:irpl:sand:DestroySandFromList|DestroySandFromList]] \\
-[[ixe:irpl:sand:GetSandDefData|GetSandDefData]] \\
-[[ixe:irpl:sand:TerpLocation|TerpLocation]] \\
-==== Math ====
-[[ixe:irpl:math:SignedAngle|SignedAngle]] \\
-[[ixe:irpl:math:Rotate|Rotate]] \\
-[[ixe:irpl:math:SetDirRight|SetDirRight]] \\
-[[ixe:irpl:math:GetDirUp|GetDirUp]] \\
-[[ixe:irpl:math:SetDirUp|SetDirUp]] \\
-[[ixe:irpl:math:CalculateTrajectoryVelocity|CalculateTrajectoryVelocity]] \\
-==== Shots ====
-[[ixe:irpl:shots:CreateShot|CreateShot]] \\
-[[ixe:irpl:shots:CreateRaRocket|CreateRaRocket]] \\
-[[ixe:irpl:shots:CreateParticulateShot|CreateParticulateShot]] \\
-==== Game ====
-[[ixe:irpl:game:GetUpgradeBoost|GetUpgradeBoost]] \\
-[[ixe:irpl:game:SetUpgradeBoost|SetUpgradeBoost]] \\
-[[ixe:irpl:game:GetMissionRequirementsMet|GetMissionRequirementsMet]] \\
-[[ixe:irpl:game:GetCategory|GetCategory]] \\
-[[ixe:irpl:game:GetGameUpdateCount|GetGameUpdateCount]] \\
-[[ixe:irpl:game:ClearConsole|ClearConsole]] \\
-[[ixe:irpl:game:StopConsole|StopConsole]] \\
-[[ixe:irpl:game:GetArgs|GetArgs]] \\
-[[ixe:irpl:game:Jump|Jump]] \\
-[[ixe:irpl:game:FlashScreen|FlashScreen]] \\
-[[ixe:irpl:game:ShowInventory|ShowInventory]] \\
-[[ixe:irpl:game:ShowInfoArea|ShowInfoArea]] \\
-[[ixe:irpl:game:ShowResourceArea|ShowResourceArea]] \\
-[[ixe:irpl:game:GetShieldsEnabled|GetShieldsEnabled]] \\
-[[ixe:irpl:game:SetShieldsEnabled|SetShieldsEnabled]] \\
-[[ixe:irpl:game:TerpPaintingEnabled|TerpPaintingEnabled]] \\
-[[ixe:irpl:game:IsPassable|IsPassable]] \\
-[[ixe:irpl:game:GetEditMode|GetEditMode]] \\
-[[ixe:irpl:game:QuickSave|QuickSave]] \\
-[[ixe:irpl:game:QuickLoad|QuickLoad]] \\
-[[ixe:irpl:game:Sys_Operable|Sys_Operable]]\\
-[[ixe:irpl:game:GetPause|GetPause]] \\
-[[ixe:irpl:game:SetPause|SetPause]] \\
-[[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:GetPositionInventoryButton|GetPositionInventoryButton]] \\
-[[ixe:irpl:game:GetPositionTerpControls|GetPositionTerpControls]] \\
-[[ixe:irpl:game:GetPositionPauseControl|GetPositionPauseControl]] \\
-[[ixe:irpl:game:GetPositionHelpButton|GetPositionHelpButton]] \\
-[[ixe:irpl:game:ShowUiIndicator|ShowUiIndicator]] \\
-[[ixe:irpl:game:GetTerpControlsOpen|GetTerpControlsOpen]] \\
-[[ixe:irpl:game:SetTerpControlsOpen|SetTerpControlsOpen]] \\
-[[ixe:irpl:game:GetHelpOpen|GetHelpOpen]] \\
-[[ixe:irpl:game:SetHelpOpen|SetHelpOpen]] \\
-[[ixe:irpl:game:GetMissionCompletionDialogOpen|GetMissionCompletionDialogOpen]] \\
-[[ixe:irpl:game:GetReturningToOrbit|GetReturningToOrbit]] \\
-[[ixe:irpl:game:SetMissionCompletionDialogSuppressed|SetMissionCompletionDialogSuppressed]] \\
-[[ixe:irpl:game:AwardMissionComplete|AwardMissionComplete]] \\
-[[ixe:irpl:game:MissionLoss|MissionLoss]] \\
-[[ixe:irpl:game:GetApex|GetApex]] \\
-[[ixe:irpl:game:SetSuppressApexJump|SetSuppressApexJump]] \\
-[[ixe:irpl:game:GetSelectedUnits|GetSelectedUnits]] \\
-[[ixe:irpl:game:HasSelectedUnit|HasSelectedUnit]] \\
-[[ixe:irpl:game:UseLegalUnitCells|UseLegalUnitCells]] \\
-[[ixe:irpl:game:SetLegalUnitCells|SetLegalUnitCells]] \\
-[[ixe:irpl:game:SetLegalUnitCellsRect|SetLegalUnitCellsRect]] \\
-[[ixe:irpl:game:ClearLegalUnitCells|ClearLegalUnitCells]] \\
-[[ixe:irpl:game:GetMcsItem|GetMcsItem]] \\
-[[ixe:irpl:game:SetMcsItem|SetMcsItem]] \\
-[[ixe:irpl:game:GetAllMcsKeys|GetAllMcsKeys]] \\
-==== Effects ====
-[[ixe:irpl:effects:CreateSandExplosion|CreateSandExplosion]] \\
-[[ixe:irpl:effects:CreateEffect|CreateEffect]] \\
-==== Beams ====
-[[ixe:irpl:beams:CreateBeam|CreateBeam]] \\
-[[ixe:irpl:beams:DestroyBeam|DestroyBeam]] \\
-[[ixe:irpl:beams:SetBeamStart|SetBeamStart]] \\
-[[ixe:irpl:beams:SetBeamEnd|SetBeamEnd]] \\
-[[ixe:irpl:beams:SetBeamEnabled|SetBeamEnabled]] \\
-[[ixe:irpl:beams:SetBeamColor|SetBeamColor]] \\
-[[ixe:irpl:beams:SetBeamWidth|SetBeamWidth]] \\
-[[ixe:irpl:beams:SetBeamCapVertices|SetBeamCapVertices]] \\
-[[ixe:irpl:beams:BeamExists|BeamExists]] \\
-[[ixe:irpl:beams:SetBeamAutoDisable|SetBeamAutoDisable]] \\
-==== IO ====
-[[ixe:irpl:io:GetMousePos|GetMousePos]] \\
-[[ixe:irpl:io:GetMouseCell|GetMouseCell]] \\
-[[ixe:irpl:io:GetMouseButtonDown|GetMouseButtonDown]] \\
-[[ixe:irpl:io:GetMouseButtonUp|GetMouseButtonUp]] \\
-[[ixe:irpl:io:GetMouseButton|GetMouseButton]] \\
-[[ixe:irpl:io:GetKeyDown|GetKeyDown]] \\
-[[ixe:irpl:io:GetKey|GetKey]] \\
-[[ixe:irpl:io:GetMappedKey|GetMappedKey]] \\
-[[ixe:irpl:io:GetMappedKeyDown|GetMappedKeyDown]] \\
-[[ixe:irpl:io:GetMappedKeyStrings|GetMappedKeyStrings]] \\
-[[ixe:irpl:io:SetMoveMapManualMode|SetMoveMapManualMode]] \\
-==== Fields ====
-[[ixe:irpl:fields:CreateFc|CreateFc]] \\
-[[ixe:irpl:fields:DestroyFc|DestroyFc]] \\
-[[ixe:irpl:fields:DeployFc|DeployFc]] \\
-[[ixe:irpl:fields:SetFcSave|SetFcSave]] \\
-[[ixe:irpl:fields:GetFc|GetFc]] \\
-[[ixe:irpl:fields:GetFcs|GetFcs]] \\
-[[ixe:irpl:fields:SetFcPosition|SetFcPosition]] \\
-[[ixe:irpl:fields:SetFcApplyCreeper|SetFcApplyCreeper]] \\
-[[ixe:irpl:fields:SetFcApplyAc|SetFcApplyAc]] \\
-[[ixe:irpl:fields:SetFcIsPin|SetFcIsPin]] \\
-[[ixe:irpl:fields:SetFcVisible|SetFcVisible]] \\
-[[ixe:irpl:fields:FillFcPin|FillFcPin]] \\
-[[ixe:irpl:fields:FillFcRadial|FillFcRadial]] \\
-[[ixe:irpl:fields:FillFcLinear|FillFcLinear]] \\
-[[ixe:irpl:fields:FillFcIsland|FillFcIsland]] \\
-==== Sound ====
-[[ixe:irpl:sound:PlaySound|PlaySound]] \\
-[[ixe:irpl:sound:PlaySoundLoop|PlaySoundLoop]] \\
-[[ixe:irpl:sound:StopSoundLoop|StopSoundLoop]] \\
-[[ixe:irpl:sound:SetSoundLoopPitch|SetSoundLoopPitch]] \\
-==== Inventory ====
-[[ixe:irpl:inventory:AddPlanToInventory|AddPlanToInventory]] \\
-[[ixe:irpl:inventory:RemovePlanFromInventory|RemovePlanFromInventory]] \\
-[[ixe:irpl:inventory:GetInventory|GetInventory]] \\
-[[ixe:irpl:inventory:HasInventory|HasInventory]] \\
-[[ixe:irpl:inventory:ClearInventory|ClearInventory]] \\
-==== UI ====
-[[ixe:irpl:ui:CreateUi|CreateUi]] \\
-[[ixe:irpl:ui:DestroyUi|DestroyUi]] \\
-[[ixe:irpl:ui:GetUiExists|GetUiExists]] \\
-[[ixe:irpl:ui:SetUiActive|SetUiActive]] \\
-[[ixe:irpl:ui:SetUiPosition|SetUiPosition]] \\
-[[ixe:irpl:ui:SetUiSize|SetUiSize]] \\
-[[ixe:irpl:ui:SetUiColor|SetUiColor]] \\
-[[ixe:irpl:ui:SetUiBackgroundColor|SetUiBackgroundColor]] \\
-[[ixe:irpl:ui:SetUiText|SetUiText]] \\
-==== Messaging ====
-[[ixe:irpl:messaging:ShowConversation|ShowConversation]] \\
-[[ixe:irpl:messaging:GetConversationOpen|GetConversationOpen]] \\
-[[ixe:irpl:messaging:ShowBubbleMessage|ShowBubbleMessage]] \\
-[[ixe:irpl:messaging:ShowBubbleMessage_Sound|ShowBubbleMessage_Sound]] \\
-[[ixe:irpl:messaging:CloseBubbleMessage|CloseBubbleMessage]] \\
-[[ixe:irpl:messaging:ShowUiHelp|ShowUiHelp]] \\
-[[ixe:irpl:messaging:ShowGameMessage|ShowGameMessage]] \\
-[[ixe:irpl:messaging:CloseGameMessage|CloseGameMessage]] \\
-[[ixe:irpl:messaging:GetGameMessageOpen|GetGameMessageOpen]] \\
-<newcolumn>
-==== Sprites ====
-[[ixe:irpl:sprites:CreateSprite|CreateSprite]] \\
-[[ixe:irpl:sprites:DestroySprite|DestroySprite]] \\
-[[ixe:irpl:sprites:SetSpriteActive|SetSpriteActive]] \\
-[[ixe:irpl:sprites:SetSpriteParent|SetSpriteParent]] \\
-[[ixe:irpl:sprites:SetSpriteOrder|SetSpriteOrder]] \\
-[[ixe:irpl:sprites:SetSpritePosition|SetSpritePosition]] \\
-[[ixe:irpl:sprites:SetSpriteRotation|SetSpriteRotation]] \\
-[[ixe:irpl:sprites:SetSpriteScale|SetSpriteScale]] \\
-[[ixe:irpl:sprites:SetSpriteColor|SetSpriteColor]] \\
-[[ixe:irpl:sprites:SetSpriteAlpha|SetSpriteAlpha]] \\
-------
-End of list. What follows is Work in progress or experimentation
-----------
-<nspages -subns -textPages="IRPL Reference" -simplelist -nbCol=1>
-<nspages  .:arithmetic -textNS="IRPL Function list">

Knuckle Cracker Wiki

User Tools

Site Tools

Differences

Page Tools