Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
prpl:prplreference [2017/10/31 10:38] – Added command Self to category Scripts. GameGibu | prpl:prplreference [2018/06/14 16:57] – improved links kajacx |
---|
~~NOTOC~~ | ~~NOTOC~~ |
| |
<html><!--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. --></html> | |
<-[[pf:particle_fleet|PF Home]]<- [[prpl:start|PRPL Home]]\\ | <-[[pf:particle_fleet|PF Home]]<- [[prpl:start|PRPL Home]]\\ |
====== PRPL Reference ====== | ====== PRPL Reference ====== |
[[.:prplreference#ships|Ships]]\\ | [[.:prplreference#ships|Ships]]\\ |
[[.:prplreference#units|Units]]\\ | [[.:prplreference#units|Units]]\\ |
| [[.:prplreference#particles|Particles]]\\ |
[[.:prplreference#plasma|Plasma]]\\ | [[.:prplreference#plasma|Plasma]]\\ |
[[.:prplreference#map_mission|Map/Mission]]\\ | [[.:prplreference#map_mission|Map/Mission]]\\ |
| |
==== Language API ==== | ==== Language API ==== |
<columns 100% 50% 0% 50% -><html><span id="vars_and_functions"></span></html> | <columns 100% 50% 0% 50% -> |
| |
| === Vars and Functions === |
^ Vars and Functions ^^^ | ^ Vars and Functions ^^^ |
| [[.:define|$VARNAME:DEF_VAL]]| [[.:ClearLocals|ClearLocals]]| [[.:ClearGlobals|ClearGlobals]] | | | [[.:define|$VARNAME:DEF_VAL]]| [[.:ClearLocals|ClearLocals]]| [[.:ClearGlobals|ClearGlobals]] | |
| [[.:func|:FUNC_NAME]] | [[.:comment|#]] | | | | [[.:func|:FUNC_NAME]] | [[.:comment|#]] | | |
| |
<html><span id="comparators"></span></html> | === Comparators === |
| |
^ Comparators ^^^ | ^ Comparators ^^^ |
| [[.:false|false]] | | | [[.:false|false]] | |
| |
<html><span id="built_in_functions"></span></html> | === Built in Functions === |
| |
^ Built in Functions ^^^ | ^ Built in Functions ^^^ |
| [[.:func|:Destroyed]]| [[.:func|:Awake]]| [[.:func|:GameLoaded]] | | | [[.:func|:Destroyed]]| [[.:func|:Awake]]| [[.:func|:GameLoaded]] | |
| |
<html><span id="logical_operators"></span></html> | === Logical Operators === |
| |
^ Logical Operators ^^^ | ^ Logical Operators ^^^ |
| [[.:not |not ]] | | | [[.:not |not ]] | |
| |
<html><span id="program_flow_control"></span></html> | === Program Flow Control === |
| |
^ Program Flow Control ^^^ | ^ Program Flow Control ^^^ |
| [[.:K|K]]| [[.:while|while]]| [[.:repeat |repeat ]] | | | [[.:K|K]]| [[.:while|while]]| [[.:repeat |repeat ]] | |
| [[.:endwhile|endwhile]]| [[.:break|break]]| [[.:return|return]] | | | [[.:endwhile|endwhile]]| [[.:break|break]]| [[.:return|return]] | |
| [[.:delay |delay ]] | | | [[.:Delay |Delay ]] | |
| |
<html><span id="math"></span></html> | === Math === |
| |
^ Math ^^^ | ^ Math ^^^ |
| [[.:TWOPI|TWOPI]] | | | [[.:TWOPI|TWOPI]] | |
| |
<html><span id="stack_manipulation"></span></html> | === Stack Manipulation === |
| |
^ Stack Manipulation ^^^ | ^ Stack Manipulation ^^^ |
</columns> | </columns> |
| |
<html><span id="debugging"></span></html> | === Debugging === |
| |
^ Debugging ^^^ | ^ Debugging ^^^ |
| [[.:debug|debug]] | | | | | [[.:Debug|Debug]] | | | |
| [[.:trace|trace]]| [[.:print|print]]| [[.:traceall|traceall]] | | | [[.:Trace|Trace]]| [[.:Print|Print]]| [[.:TraceAll|TraceAll]] | |
| [[.:printall|printall]]| [[.:traceallsp|traceallsp]]| [[.:printallsp|printallsp]] | | | [[.:PrintAll|PrintAll]]| [[.:TraceAllSp|TraceAllSp]]| [[.:PrintAllSp|PrintAllSp]] | |
| [[.:trace2|trace2]]| [[.:print2|print2]]| [[.:trace3|trace3]] | | | [[.:Trace2|Trace2]]| [[.:Print2|Print2]]| [[.:Trace3|Trace3]] | |
| [[.:print3|print3]]| [[.:trace4|trace4]]| [[.:print4|print4]] | | | [[.:Print3|Print3]]| [[.:Trace4|Trace4]]| [[.:Print4|Print4]] | |
| [[.:trace5|trace5]]| [[.:print5|print5]]| [[.:tracestack|tracestack]] | | | [[.:Trace5|Trace5]]| [[.:Print5|Print5]]| [[.:TraceStack|TraceStack]] | |
| [[.:printstack|printstack]]| [[.:cleartracelog|cleartracelog]]| | | | [[.:PrintStack|PrintStack]]| [[.:ClearTraceLog|ClearTraceLog]]| | |
| |
==== Platform API ==== | ==== Platform API ==== |
<columns 100% 50% 0% 50% -><html><span id="timers"></span></html> | <columns 100% 50% 0% 50% -> |
| === Timers === |
| |
^ Timers ^^^ | ^ Timers ^^^ |
| [[.:GetTimer0|GetTimer0]]| [[.:GetTimer1|GetTimer1]]| [[.:GetTimer2|GetTimer2]] | | | [[.:GetTimer0|GetTimer0]] | [[.:GetTimer1|GetTimer1]] | [[.:GetTimer2|GetTimer2]] | |
| [[.:GetTimer3|GetTimer3]]| [[.:SetTimer0|SetTimer0]]| [[.:SetTimer1|SetTimer1]] | | | [[.:SetTimer0|SetTimer0]] | [[.:SetTimer1|SetTimer1]] | [[.:SetTimer2|SetTimer2]] | |
| [[.:SetTimer2|SetTimer2]] | | | [[.:GetTimer3|GetTimer3]] | | | |
| [[.:SetTimer3|SetTimer3]] | | | [[.:SetTimer3|SetTimer3]] | | | |
| |
<html><span id="strings"></span></html> | === Strings === |
| |
^ Strings ^^^ | ^ Strings ^^^ |
| [[.:DoubleQuote|DoubleQuote]] | | | | | [[.:DoubleQuote|DoubleQuote]] | | | |
| |
<html><span id="input"></span></html> | === Input === |
| |
^ Input ^^^ | ^ Input ^^^ |
| [[.:GetMouseCell|GetMouseCell]] | [[.:GetMousePosition|GetMousePosition]] | | | | [[.:GetMouseCell|GetMouseCell]] | [[.:GetMousePosition|GetMousePosition]] | | |
| |
<html><span id="lists"></span></html> | === Lists === |
| |
^ Lists ^^^ | ^ Lists ^^^ |
| [[.:SetListElementRpn|SetListElementRpn]] | [[.:RemoveListElement|RemoveListElement]] | | | | [[.:SetListElementRpn|SetListElementRpn]] | [[.:RemoveListElement|RemoveListElement]] | | |
| |
<html><span id="scripts"></span></html> | === Scripts === |
| |
^ Scripts ^^^ | ^ Scripts ^^^ |
| [[.:operatewhilepaused|operatewhilepaused]] | [[.:self|Self]] | | | | [[.:operatewhilepaused|operatewhilepaused]] | [[.:self|Self]] | | |
| |
<html><span id="ships"></span></html> | === Ships === |
| |
^ Ships ^^^ | ^ Ships ^^^ |
| [[.:AddCustomShipToInventory |AddCustomShipToInventory ]]| [[.:SetShipThrustMultiplier|SetShipThrustMultiplier]] | | | [[.:AddCustomShipToInventory |AddCustomShipToInventory ]]| [[.:SetShipThrustMultiplier|SetShipThrustMultiplier]] | |
| |
<html><span id="units"></span></html> | === Units === |
| |
^ Units ^^^ | ^ Units ^^^ |
| | [[.:createunit|CreateUnit]] | [[.:createemergent|CreateEmergent]] | | |
| [[.:SetUnitCurrentCoords|SetUnitCurrentCoords]] | [[.:SetUnitCurrentX|SetUnitCurrentX]] | [[.:SetUnitCurrentY|SetUnitCurrentY]] | | | [[.:SetUnitCurrentCoords|SetUnitCurrentCoords]] | [[.:SetUnitCurrentX|SetUnitCurrentX]] | [[.:SetUnitCurrentY|SetUnitCurrentY]] | |
| [[.:GetUnitTransformPosition|GetUnitTransformPosition]] | [[.:getallunitsinrange|getallunitsinrange]] | [[.:setunitselectable|SetUnitSelectable]] | | | [[.:GetUnitTransformPosition|GetUnitTransformPosition]] | [[.:getallunitsinrange|getallunitsinrange]] | [[.:setunitselectable|SetUnitSelectable]] | |
| |
<html><span id="plasma"></span></html> | === Particles === |
| |
| ^ Particles ^^^ |
| | [[.:createparticle|CreateParticle]] | [[.:destroyparticle|DestroyParticle]] | [[.:damageparticle|Damageparticle]] | |
| | [[.:particleexists|ParticleExists]] | [[.:getparticlesinrange|GetParticlesInRange]] | [[.:getparticlesinradius|GetParticlesInRadius]] | |
| | [[.:getparticlecountinradius|GetParticleCountInRadius]] | [[.:teleportparticle|TeleportParticle]] | [[.:getparticlehasteleported|GetParticleHasTeleported]] | |
| | [[.:getallconnectedparticles|GetAllConnectedParticles]] | [[.:getallconnectedparticlecount|GetAllConnectedParticleCount]] | | |
| | [[.:isparticle|isParticle]] | [[.:ishull|isHull]] | [[.:isemergent|isEmergent]] | |
| | [[.:isomni|isOmni]] | | | |
| | [[.:createbond|CreateBond]] | [[.:destroybond|DestroyBond]] | [[.:bondexists|BondExists]] | |
| | [[.:getallconnectedbonds|GetAllConnectedBonds]] | | | |
| |
| === Plasma === |
| |
^ Plasma ^^^ | ^ Plasma ^^^ |
| [[.:SetPlasmaBulk |SetPlasmaBulk ]] | [[.:GetPlasmaDecay |GetPlasmaDecay ]]| | | | [[.:SetPlasmaBulk |SetPlasmaBulk ]] | [[.:GetPlasmaDecay |GetPlasmaDecay ]]| | |
| |
<html><span id="map_mission"></span></html> | === Map/Mission === |
| |
^ Map/Mission ^^^ | ^ Map/Mission ^^^ |
| [[.:iseditmode|IsEditMode]] | | | | | [[.:iseditmode|IsEditMode]] | | | |
| |
<html><span id="screen"></span></html> | === Screen === |
| |
^ Screen ^^^ | ^ Screen ^^^ |
| [[.:setscreenpixelcoords|setscreenpixelcoords]]| [[.:setscreenpixelcoordx|setscreenpixelcoordx]]| [[.:setscreenpixelcoordy|setscreenpixelcoordy]] | | | [[.:setscreenpixelcoords|setscreenpixelcoords]]| [[.:setscreenpixelcoordx|setscreenpixelcoordx]]| [[.:setscreenpixelcoordy|setscreenpixelcoordy]] | |
| |
<html><span id="everything_else_2"></span></html> | === Everything Else 2 === |
| |
^ Everything Else 2 ^^^ | ^ Everything Else 2 ^^^ |