Transcendence Community Wiki

This is an old revision of the document!

Discuss this page on this pages TalkPage

shpOrder

Syntax	(shpOrder ship string [expression])
Arguments	ship: The ship that you want to order.
	string: A string representing the order.
	expression: The optional arguments if needed by the order. Multiple arguments possible
Returns	condition: True if successful, Nil otherwise.
Category	orders, ship
Description	Gives the ship the order.

shpOrder
- ship
  - order
    - “guard”
      - Target
    - “dock”
      - Target
    - “attack”
      - Target
      - [Duration in seconds]
    - “wait”
      - [Duration in seconds]
    - “gate”
      - [Gate]
    - “gateOnThreat”
    - “gateOnStationDestroyed”
    - “patrol”
      - Target
      - Distance
    - “escort”
      - Target
      - [Angle]|[Formation]
      - [Distance]
    - “scavenge”
    - “followPlayerThroughGate”
      - Target
    - “attackNearestEnemy”
    - “tradeRoute”
    - “wander”
    - “loot”
      - Target
    - “hold”
      - Duration
    - “mine”
      - Target
    - “waitForPlayer”
    - “attackPlayerOnReturn”
    - “follow”
      - Target
    - “navPath”
      - Integer ¹⁾
    - “goto”
      - Object
    - “waitForTarget”
      - Target
      - Integer ²⁾
      - Integer ³⁾
    - “waitForEnemy”
      - Duration
    - “bombard”
      - Target
      - Integer ⁴⁾
    - “approach”
      - Target
      - Distance
    - “aim”
      - Target
    - “orbit”
      - Target
      - Distance
      - Integer ⁵⁾
    - “holdCourse”
      - Angle
      - Distance
    - “turnTo”
      - Angle (absolute)
    - “attackHold”
      - Target
      - Duration
    - “attackStation”
      - Target
      - Integer ⁶⁾
    - “fireEvent” Fires the event on the target's event handler. aShipObj is the ship that fired it.
      - Target
      - String (event name)
    - “waitForUndock”
      - Target
      - Duration
    - “sendMessage”
      - Target
      - Message
    - “attackArea”
      - Target ⁷⁾
      - Integer ⁸⁾
      - Integer ⁹⁾
    - “holdAndAttack”
      - Target
      - Integer ¹⁰⁾
    - “gotoPos”
      - Position vector
    - “waitForThreat”
      - Duration
    - “sentry”
      - Target
      - Integer ¹¹⁾

Example

(shpOrder gPlayerShip 'wait)

Returns True, ordering the player to wait doesn't do much. Return to Functions list

¹⁾ , ²⁾ , ³⁾ , ⁴⁾ , ⁵⁾ , ⁶⁾ , ⁷⁾ , ⁸⁾ , ⁹⁾ , ¹⁰⁾ , ¹¹⁾

Unknown