Knuckle Cracker Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
<- [[.:prplreference| PRPL reference]] <- [[.:upgradenotes#accessor_notation|Upgrade Notes]]

=====  Accessor Notation (AcNot)  =====

==== Description ====
Accessor Notation is a new feature in PRPL. It provides a simpler way to access the properties of units than in CRPL. Whereas in CRPL one would get/set unit attributes with:
<code crpl>
# Set Unit Attribute
<-UID CONST_UNITATTRIBUTE <-Value SetUnitAttribute
# Get Unit Attribute
<-UID CONST_UNITATTRIBUTE GetUnitAttribute
</code>
PRPL allows a much faster notation styled after object property accessors in object-oriented programming languages:
<code prpl>
# Set Unit Attribute
<-Value ->UID.Attribute
# Get Unit Attribute
<-UID.Attribute
</code>
This has the advantage of being easier to read and identify, as well as the fact that all valid property tokens are not case-sensitive:
<code prpl>
# These are treated the same
<-UID.Attribute
<-UID.ATTRIBUTE
</code>
Note that Ships, Particles and Units are considered distinct; their IDs are generally referred to as SID, PID and UID respectively, and are each obtained with different commands. See [[.:getallshipsinrange|GetAllShipsInRange]], [[.:getparticlesinrange|GetParticlesInRange]] and [[.:getallunitsinrange|GetAllUnitsInRange]].

==== Attributes ====

^  Ships  ^^^^
^  Attribute  ^  Description  ^  Get  ^  Set  ^
|  ShipHasAmp | Whether the ship has an amp gem mounted. |  <code prpl><-UID.ShipHasAmp</code>  |  Cannot Be Set  |
|  ShipIsEnemy | Whether the ship is an enemy. Warning: using this on player ships can cause strange behaviour. |  <code prpl><-UID.ShipIsEnemy</code>  |  <code prpl><-Value ->UID.ShipIsEnemy</code>  |

^  Particles  ^^^^
^  Attribute  ^  Description  ^  Get  ^  Set  ^
|  - | desc |  <code prpl>#code</code>  |  <code prpl>#code</code>  |
<note> Tables for Particle, Unit and Ship here. Keep Separate! </note>

=== Examples ===
<code></code>
Knuckle Cracker Wiki

User Tools

Site Tools

Page Tools
