<- [[pf:start| Game 4 home]] <- [[:start |wiki home]] ====== PRPL reference ====== [[ pf:prpldocsrc | PRPL Doc Src]] FIXME note: I just started this, it's still a mess. Feel free to clean up or alter. 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 language API is almost identical to the [[ crpl:crplreference | CRPL language APIs]] - by reference those are included here. There are a few extensions and syntactic differences, notable for global variables (which do not exist in CRPL) and list element access (square bracket notation). Unit attribute modification has also changed format. The rest of PRPL is contained in the Platform API and is game-specific. These govern the behavior of objects in the game. To get started, review the [[crpl:overview|CRPL overview]] and the [[crpl:crpltutorial|programming tutorial]]. There is also an [[prpl:alphabetic list of commands]] in the language. In addition, you can [[prpl:examine map resources]] from other maps and missions from the game. ==== Table of Contents ==== === Language API (CRPL links) === [[crpl:crplreference#comparators|Comparators]]\\ [[crpl:crplreference#debugging|Debugging]]\\ [[crpl:crplreference#lists|Lists]] FIXME PRPL uses []\\ [[crpl:crplreference#logical_operators|Logical Operators]]\\ [[crpl:crplreference#math_commands|Math Commands]]\\ [[crpl:crplreference#flow_control|Program Flow Control]]\\ [[crpl:crplreference#script_commands|Script Commands]]\\ [[crpl:crplreference#stack_manipulation|Stack Manipulation]]\\ [[crpl:crplreference#timers|Timers]]\\ [[crpl:crplreference#utility_commands|Utility Commands]]\\ [[crpl:crplreference#vars_and_functions|Vars and Functions]]\\ [[crpl:crplreference#string_commands|String Commands]]\\ === External references === <-[[prpl:overview|PRPL Overview]]\\ <-[[prpl:Alphabetic List of Commands]]\\ <-[[Examine Map Resources]] === Platform API === For now, refer to the [[prpl:Alphabetic List of Commands]] until someone classifies them === Unit Attribute Constants === ==== Platform API ==== |< 100% >| ^ type description goes here ^^^ | | | | | | | | | | | | | | | | | | | | ^Type Description^^^ | | | | | | | | | | | | |< 100% >| ^ types ^^^^ | | | | | | | | | | | | | | |