| | 1 | '''Pyrogenesis Object Model : !EntityCollection class''' |
| | 2 | |
| | 3 | The !EntityCollection class is based on an array holding the entities that are members of the set (accessed using subscript notation). It does also include the following supplemental properties in order to control entity interaction from script. |
| | 4 | |
| | 5 | = !EntityCollection Methods = |
| | 6 | |
| | 7 | == toString (Implicit) == |
| | 8 | * '''Overview:''' |
| | 9 | * Overrides the default string conversion to include the number of entities in the set. |
| | 10 | * '''Syntax:''' |
| | 11 | * toString(); |
| | 12 | * '''Parameters:''' |
| | 13 | * None. |
| | 14 | * '''Returns:* ''' |
| | 15 | * A string of the form '[object !EntityCollection: <Number> entities]'.Notes: |
| | 16 | This function is called implicitly by the !JavaScript engine to convert this object to a string. |
| | 17 | |
| | 18 | == isOrderTypeValid == |
| | 19 | * '''Overview:''' |
| | 20 | * Returns a value indicating whether the specified order type is valid for the selection and current target. |
| | 21 | * '''Syntax:''' |
| | 22 | * selection.isOrderTypeValid( code ); |
| | 23 | * '''Parameters:''' |
| | 24 | * code: An integer giving the code of the order to check. |
| | 25 | * '''Returns:''' |
| | 26 | * True, if the order is valid for the current selection and target. False otherwise. |
| | 27 | * '''Notes:''' |
| | 28 | * Use of this method is only valid on !EntityCollections representing the current user selection (i.e. the selection object). The current target is the entity or map location the user cursor is currently over. |
| | 29 | |
| | 30 | = !EntityCollection Properties = |
| | 31 | |
| | 32 | == orderType == |
| | 33 | * '''Overview:''' |
| | 34 | * Gets or sets a value representing the currently active context-sensitive order. |
| | 35 | * '''Type:''' |
| | 36 | * integer |
| | 37 | * '''Notes:''' |
| | 38 | * Use of this property is only valid on !EntityCollections representing the current user selection (i.e. the selection object). -1 indicates that no context-sensitive order cursor is to be displayed. The sets of values that are valid for this property are dependant on the current selection and object(s) the mouse is over; for this reason, this property may be changed whenever the cursor is moved. |
