Knuckle Cracker Wiki

User Tools

Site Tools

Trace: • prpl_information
pf:prpl_information

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
pf:prpl_information [2015/02/28 15:58] – Karsten75pf:prpl_information [2025/02/14 14:57] (current) – external edit 127.0.0.1
Line 2: Line 2:
  
 ====== PRPL reference ====== ====== 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. FIXME note: I just started this, it's still a mess. Feel free to clean up or alter.
Line 7: Line 8:
 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. 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 identical to the [[ crpl:crplreference | CRPL language APIs]] - by reference those are included here.+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. The rest of PRPL is contained in the Platform API and is game-specific. These govern the behavior of objects in the  game.
Line 13: Line 14:
 To get started, review the [[crpl:overview|CRPL overview]] and the [[crpl:crpltutorial|programming tutorial]]. To get started, review the [[crpl:overview|CRPL overview]] and the [[crpl:crpltutorial|programming tutorial]].
  
-There is also an [[alphabetic list of commands]] in the language. In addition, you can [[crpl:examine map resources]] from other maps and missions from the game.+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.
  
  
Line 24: Line 25:
 [[crpl:crplreference#comparators|Comparators]]\\ [[crpl:crplreference#comparators|Comparators]]\\
 [[crpl:crplreference#debugging|Debugging]]\\ [[crpl:crplreference#debugging|Debugging]]\\
-[[crpl:crplreference#lists|Lists]]\\+[[crpl:crplreference#lists|Lists]] FIXME PRPL uses []\\
 [[crpl:crplreference#logical_operators|Logical Operators]]\\ [[crpl:crplreference#logical_operators|Logical Operators]]\\
 [[crpl:crplreference#math_commands|Math Commands]]\\ [[crpl:crplreference#math_commands|Math Commands]]\\
Line 36: Line 37:
  
 === External references === === External references ===
-<-[[crpl:overview|CRPL Overview]]\\ +<-[[prpl:overview|PRPL Overview]]\\ 
-<-[[Alphabetic List of Commands]]\\+<-[[prpl:Alphabetic List of Commands]]\\
 <-[[Examine Map Resources]] <-[[Examine Map Resources]]
 <newcolumn> <newcolumn>
Line 43: Line 44:
 === Platform API === === Platform API ===
  
-For now, refer to the alphabetic list of commands until someone classifies them+<note tip> For now, refer to the [[prpl:Alphabetic List of Commands]] until someone classifies them</note> 
 + 
  
 === Unit Attribute Constants === === Unit Attribute Constants ===
Line 49: Line 52:
 </columns> </columns>
  
-==== Language API ==== +==== Platform API ==== 
 <columns 100% 50% 0% 50% -> <columns 100% 50% 0% 50% ->
-<html><span id="vars_and_functions"></span></html>+<html><span id="type_description_goes_here"></span></html>
 |< 100% >| |< 100% >|
-^ Vars and Functions ^^^ +^ type description goes here ^^^ 
-| [[crpl:docs:define|$VARNAME:DEF_VAL]] | [[crpl:docs:ClearLocals]] | [[crpl:docs:delete|--VARNAME]]           | +|  |  |  | 
-| [[crpl:docs:read|<-VARNAME]]  | [[crpl:docs:write|->VARNAME]] | [[crpl:docs:exists|-?VARNAME]]          | +|  |  |  | 
-| [[crpl:docs:refread|<-!]]     | [[crpl:docs:refwrite|->!]]   | [[crpl:docs:refexists|-?!]]             | +|  |  |  | 
-| [[crpl:docs:refdelete|--?]] | |  | +|  |  |  | 
-| [[crpl:docs:call|@FUNC_NAME]] | [[crpl:docs:func|:FUNC_NAME]] |  |+|  |  |  |
  
-^Built-in Functions^^^ +^Type Description^^^ 
-| [[crpl:docs:func_destroyed|:destroyed]] | [[crpl:docs:func_awake|:awake]] | [[crpl:docs:func_GameLoaded|:GameLoaded]] | +| | |  | 
-| [[crpl:docs:func_ShowMessageDialogCallback|:ShowMessageDialogCallback]] | |  | +| | |  | 
-| [[crpl:docs:func_UserCancelAction|:UserCancelAction]] | |  |+| | |  |
  
 <newcolumn> <newcolumn>
  
-<html><span id="comparators"></span></html>+<html><span id="types"></span></html>
 |< 100% >| |< 100% >|
-^ Comparators ^^^^ +^ types ^^^^ 
-| [[crpl:docs:gt]]   | [[crpl:docs:gte]]   | [[crpl:docs:lt]]  | [[crpl:docs:lte]]  | +|   |    |  | | 
-| [[crpl:docs:eq]]   | [[crpl:docs:neq]]   | [[crpl:docs:eq0]] | [[crpl:docs:neq0]] |  +|   |    |  | |  
-| [[crpl:docs:TRUE]] | [[crpl:docs:FALSE]] |                   |                    |+|   |    |  | |
 </columns> </columns>
  
pf/prpl_information.1425139088.txt.gz · Last modified: 2025/02/14 14:56 (external edit)

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