~~NOTOC~~
<-[[cw3:creeper_world_3|CW3 Home]]<- [[crpl:start|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|CRPL overview]] and the [[crpl:crpltutorial|programming tutorial]]. If you seek to write neater code, read the [[crpl:styleguide|style guide]].
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 ===
[[.:prplreference#vars_and_functions|Vars and Functions]]\\
[[.:prplreference#comparators|Comparators]]\\
=== Platform API ===
==== Language API ====
^ Vars and Functions ^^^
| [[.:define|$VARNAME:DEF_VAL]] |
| [[.:ClearLocals|ClearLocals]] |
| [[.:delete|--VARNAME]] |
| [[.:read|<-VARNAME]] |
| [[.:write|->VARNAME ]] |
| [[.:exists|-?VARNAME]] |
| [[.:refread|<-! ]] |
| [[.:refwrite|->! ]] |
| [[.:refexists|-?! ]] |
| [[.:refdelete|--?]] |
| [[.:call|@FUNC_NAME]] |
| [[.:func|:FUNC_NAME]] |
| [[.:comment|#]] |
^ Comparators ^^^
| [[.:gt |gt ]] |
| [[.:gte |gte ]] |
| [[.:lt |lt ]] |
| [[.:lte |lte ]] |
| [[.:eq |eq ]] |
| [[.:neq |neq ]] |
| [[.:eq0 |eq0 ]] |
| [[.:neq0 |neq0 ]] |
| [[.:true|true]] |
| [[.:false|false]] |