LuaDocs/ACraft
From Data Realms Wiki
(Difference between revisions)
(ACraft - Automatically generated by LuaBot) |
(ACraft - Automatically generated by LuaBot) |
||
| (3 intermediate revisions not shown) | |||
| Line 6: | Line 6: | ||
[[LuaDocs/Index|'''Go back to Class Index''']] | [[LuaDocs/Index|'''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 | ||
| + | |||
| Line 11: | 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. | ||
| + | |||
| + | ===MaxPassengers=== | ||
| + | Read-only property. The recomended, not absolute, maximum number of actors that fit in the invetory. Used by the activity AI.An integer with the recomended number of actors that fit in the craft. Default is -1 (unknown). | ||
| + | |||
| + | |||
| + | ==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. | ||
| + | |||
[[LuaDocs/Index|'''Go back to Class Index''']] | [[LuaDocs/Index|'''Go back to Class Index''']] | ||
Latest revision as of 08:57, 15 May 2014
Contents |
Parent: Actor
Abstract Class. A flying Actor which carries other things and can drop them.
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.
MaxPassengers
Read-only property. The recomended, not absolute, maximum number of actors that fit in the invetory. Used by the activity AI.An integer with the recomended number of actors that fit in the craft. Default is -1 (unknown).
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.
