Knuckle Cracker Wiki

User Tools

Site Tools

Trace: • crplreference
crpl:crplreference

This is an old revision of the document!

<!--In order to align tables in the two columns, I used a hack. I placed only one table in a column, created a column break, placed the opposing table and then ended the column formatting. Rinse/repeat. Essentially two tables are paired in a set of columns and this pattern is then repeated. --> <-CW3 Home<- CRPL Home

CRPL Reference

This reference is divided into two major sections with many subsections in each of those. The purpose of this reference is to provide an index to all commands in the language, and define the input required and the output produced by each command. In many instances a short example of the use of the command is provided.

The Language API (Application Programming Interface) is related and common in many languages - these are used to control program execution and are part of the core language.

The rest of CRPL is contained in the Platform API and is CW3-specific. These govern the behavior of objects in the CW3 game.

To get started, review the CRPL overview and the programming tutorial.

There is also an alphabetic list of commands in the language. In addition, you can examine map resources from other maps and missions from the game.

Table of Contents

Language API

Comparators
Debugging
Lists
Logical Operators
Math Commands
Program Flow Control
Script Commands
Stack Manipulation
Timers
Utility Commands
Screen Commands
Vars and Functions
String Commands

External references

<-CRPL Overview
<-Alphabetic List of Commands
<-Examine Map Resources

Platform API

Conversation Commands
Creeper Commands
Digitalis Commands
Image Commands
Input Commands
List Commands
Sound Commands
Movement Commands
Runner Commands
Score Commands
Spore Commands
Terrain and Wall Commands
Unit Commands
Text Commands

Unit Attribute Constants

Constants

Language API

<span id="vars_and_functions"></span>

Vars and Functions
$VARNAME:DEF_VAL ClearLocals --VARNAME
<-VARNAME ->VARNAME -?VARNAME
<-! ->! -?!
--?
@FUNC_NAME :FUNC_NAME
Built-in Functions
:destroyed :awake :GameLoaded
:ShowMessageDialogCallback
:UserCancelAction

<span id="comparators"></span>

Comparators
gt gte lt lte
eq neq eq0 neq0
TRUE FALSE

<span id="special"></span>

Special
#

<span id="logical_operators"></span>

Logical Operators
and or xor not

<span id="stack_manipulation"></span>

Stack Manipulation
swap dup dup2
pop ClearStack StackSize

<span id="math_commands"></span>

Math Commands
abs acos add approximately
asfloat asin asint atan
atan2 ceil cos Deg2Rad
div E floor ln
log log10 max min
mod mul neg PI
pow Rad2Deg round ShortestAngle
sin sqrt sub tan

<span id="flow_control"></span>

Program Flow Control
once endonce
if else endif
do loop
I J K
while repeat endwhile
break return delay

<span id="timers"></span>

Timers
GetTimer0 GetTimer1 GetTimer2 GetTimer3
SetTimer0 SetTimer1 SetTimer2 SetTimer3

<span id="string_commands"></span>

String Commands
Concat Substring StartsWith
EndsWith Split StringToList
ToUpper ToLower StringLength
StringReplace

<span id="input_commands"></span>

Input Commands
GetKey
GetKeyDown GetKeyUp
GetMouseButton
GetMouseButtonDown GetMouseButtonUp
GetMousePosition GetMouseCell
GetMouseScreenPosition GetMouseScreenPixelPosition
EnableAlternateControlMode
EnableNormalMouse EnableNormalKeyInput

<span id="lists"></span>

Lists
CreateList CreateListStartingSize
GetListCount
GetListElement SetListElement
InsertListElement RemoveListElement
AppendToList PrependToList
AppendStackToList PrependStackToList
CopyList DeepCopyList

Platform API

<span id="movement_commands"></span>

Movement Commands
QueueMove GetQueuedMoveCount
AbortMove SuspendMove ClearQueuedMoves
GetTargetOffsetX GetTargetOffsetY
SetTargetOffsetX SetTargetOffsetY
GetUnitTargetOffsetX GetUnitTargetOffsetY
SetUnitTargetOffsetX SetUnitTargetOffsetY

<span id="terrain_and_wall_commands"></span>

Terrain and Wall Commands
GetTerrain SetTerrain
GetTerrainOverride SetTerrainOverride
GetWall SetWall
GetVoid SetVoid
IsTerrainLOS FloodFillTerrain
PathFindTerrain

<span id="score_commands"></span>

Score Commands
GetScore SetAdditionalScore
GetAdditionalScore
AddAdditionalScore

<span id="script_commands"></span>

Script Commands
AddScriptToUnit GetScriptVar SetScriptVar

<span id="digitalis_commands"></span>

Digitalis Commands
GetDigitalis SetDigitalis
GetDigitalisGrowth SetDigitalisGrowth
GetDigitalisRaw SetDigitalisRaw IsDigitalisConnected

<span id="unit_commands"></span>

Unit Commands
Self GetUnitAttribute SetUnitAttribute
CurrentCoords CurrentX CurrentY
SetCurrentCoords SetCurrentX SetCurrentY
CurrentPixelCoords
GetUnitCountInRange GetCommandNodeCount RandUnitCoords
GetUnitsInRange GetEnemyUnitsInRange GetAllUnitsInRange
GetNearestGroundEnemy GetCoresWithVar
CreateUnit Damage Destroy
GetUnitType GetUnitAt
GetTechLimit SetTechLimit SetBuildLimit
CreateEffect CreateEffectClipped FireAoo
GetUnitTransformPosition
GetTechArtifactType SetTechArtifactType ArtifactCollected
EnableTowerField DisableTowerField
DropFromOrbit AscendToOrbit
GetCellOccupiedCount SetCellOccupiedCount
SetUnitSelectableOverride PersistCore

<span id="image_commands"></span>

Image Commands
SetImage SetImagePosition
SetImagePositionX SetImagePositionY SetImagePositionZ
SetImageScale SetImageScaleX SetImageScaleY
SetImageRotation SetImageColor
GetImagePosition
GetImagePositionX GetImagePositionY GetImagePositionZ
GetImageScale GetImageScaleX GetImageScaleY
GetImageRotation GetImageColor
RemoveImages

<span id="sound_commands"></span>

Sound Commands
PlaySound

<span id="creeper_commands"></span>

Creeper Commands
AddCreeper DamageCreeper
SetCreeperNoLower IsCreeperInRange
SetCreeper GetCreeper
MakeRain
SetCreeperFlowRate
SetCreeperFlowRateOnDigitalis
SetCreeperFlowRateRL SetCreeperFlowRateOnDigitalisRL
SetCreeperFlowRateUD SetCreeperFlowRateOnDigitalisUD
SetWind
SetCreeperEvaporationLimit
SetCreeperMax SetAntiCreeperMax
GetDeepestCreeperCell
GetPinFieldCell SetPinFieldCell
SetFieldCell GetFieldCell
SetCreeperColors GetCreeperColors

<span id="conversation_commands"></span>

Conversation Commands
AddConversationMessage ShowConversation
ClearConversation DestroyConversation
ConversationShowing ShowOpeningConversation
CloseOpeningConversation

<span id="spore_commands"></span>

Spore Commands
CreateSpore

<span id="runner_commands"></span>

Runner Commands
CreateRunner GetRunnerCount GetGlobalRunnerCount

<span id="debugging"></span>

Debugging
Trace Trace2 Trace3
Trace4 Trace5 TraceStack
ShowTraceLog ClearTraceLog HideTraceLog

<span id="utility_commands"></span>

Utility Commands
MapHeight MapWidth
RandFloat RandInt
RandCoords RandXCoord RandYCoord
RandCoordsInRange
Distance GetUpdateCount IsEditMode
ElapsedTime ResetGameTime InvocationCount
SetGameTime GetGameTimeFrames SetGameTimeFrames
FailMission DestroyAllEnemyUnits
PauseGame UnpauseGame NotPersist
SetSystemInhibited GetCurrentBuildTab
IsPaused OperateWhilePaused
CreateIndicatorArrow DestroyIndicatorArrow ShowGameEventTag

<span id="screen_commands"></span>

Screen Commands
ShowMessage
ShowMessageDismissible WasMessageDismissed
ShowMessageDialog IsMessageDialogShowing
CreateMist
ScreenHeight ScreenWidth
CellToPixel PixelToCell
SetScreenMode SetScreenCoords
SetScreenCoordX SetScreenCoordY
SetScreenPixelCoords
SetScreenPixelCoordX SetScreenPixelCoordY
GetCameraPosition SetCameraPosition
GetCameraZoom SetCameraZoom
EnableNormalZoomControl

<span id="text_commands"></span>

Text Commands
SetPopupText SetPopupTextAlwaysVisible
SetPopupTextX SetPopupTextY
SetText SetTextAnchor
SetTextColor SetTextSize
SetTextX SetTextY
crpl/crplreference.1426785902.txt.gz · Last modified: 2015/03/19 13:25 by warren

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