LuaDocs/ACraft

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
(Parent: Actor)
(ACraft - Automatically generated by LuaBot)
Line 1: Line 1:
-
===Parent:  [[LuaDocs/Actor|Actor]]===
+
===Parent:  [[Actor|Actor]]===
'''Abstract Class.'''  
'''Abstract Class.'''  
Line 6: Line 6:
[[LuaDocs/Index|'''Go back to Class Index''']]
[[LuaDocs/Index|'''Go back to Class Index''']]
 +
 +
==Enumerations==
==Enumerations==
Line 40: Line 42:
===ClassName===
===ClassName===
The class name of this Entity.A string with the friendly-formatted type name of this object.
The class name of this Entity.A string with the friendly-formatted type name of this object.
 +
 +
===HatchState===
 +
Read-only property. The current state of the hatch.An int encoding the hatch state. See the HatchState enum.
==Functions==
==Functions==
 +
===OpenHatch===
 +
Opens the hatch doors, if they're closed or closing.
 +
 +
'''Arguments:'''
 +
 +
* None.
 +
 +
'''Return value:'''
 +
 +
None.
 +
 +
===CloseHatch===
===CloseHatch===
-
Closes the hatch doors, if they're open.
+
Closes the hatch doors, if they're open or opening.
'''Arguments:'''
'''Arguments:'''

Revision as of 22:00, 5 June 2012

Contents

Parent: Actor

Abstract Class. A flying Actor which carries other things and can drop them.

Go back to Class Index


Enumerations

HatchState

  • 0 = CLOSED
  • 1 = OPENING
  • 2 = OPEN
  • 3 = CLOSING
  • 4 = HatchStateCount


Side

  • 0 = RIGHT
  • 1 = LEFT


CraftDeliverySequence

  • 0 = FALL
  • 1 = LAND
  • 2 = STANDBY
  • 3 = UNLOAD
  • 4 = LAUNCH
  • 5 = UNSTICK


AltitudeMoveState

  • 0 = HOVER
  • 1 = DESCEND
  • 2 = ASCEND


Properties

ClassName

The class name of this Entity.A string with the friendly-formatted type name of this object.

HatchState

Read-only property. The current state of the hatch.An int encoding the hatch state. See the HatchState enum.


Functions

OpenHatch

Opens the hatch doors, if they're closed or closing.

Arguments:

  • None.

Return value:

None.


CloseHatch

Closes the hatch doors, if they're open or opening.

Arguments:

  • None.

Return value:

None.


Go back to Class Index

Personal tools