LuaDocs/ACrab
From Data Realms Wiki
m (MediaWiki collapses multiple trailing new lines / carriage returns down to one between the section edited and any following. This will preserve spacing when sub-sections of "Functions" are edited.) |
m (I've never even heard anyone say a possessive form of "this". You wouldn't make "the" possessive, unless you were dumb enough to think "this" was plural and slap an apostrophe on the end.) |
||
| Line 126: | Line 126: | ||
===IsOnScenePoint=== | ===IsOnScenePoint=== | ||
| - | Indicates whether this' current graphical representation overlaps a point in absolute scene coordinates. | + | Indicates whether this ACrab's current graphical representation overlaps a point given in absolute scene coordinates. |
'''Arguments:''' | '''Arguments:''' | ||
| Line 134: | Line 134: | ||
'''Return value:''' | '''Return value:''' | ||
| - | Whether | + | Whether the graphical representation overlaps the specified scene point. |
[[LuaDocs/Index|'''Go back to Class Index''']] | [[LuaDocs/Index|'''Go back to Class Index''']] | ||
Revision as of 04:41, 10 February 2013
Contents |
Parent: Actor
Concrete Class. A crab-like actor with four legs.
Enumerations
MovementState
- 0 = STAND
- 1 = WALK
- 2 = JUMP
- 3 = DISLODGE
- 4 = MOMENTSTATECOUNT
Side
- 0 = LEFTSIDE
- 1 = RIGHTSIDE
- 2 = SIDECOUNT
Layer
- 0 = FGROUND
- 1 = BGROUND
DeviceHandlingState
- 0 = STILL
- 1 = POINTING
- 2 = SCANNING
- 3 = AIMING
- 4 = FIRING
- 5 = THROWING
- 6 = DIGGING
SweepState
- 0 = NOSWEEP
- 1 = SWEEPINGUP
- 2 = SWEEPINGPAUSE
- 3 = SWEEPINGDOWN
- 4 = SWEEMDOWNPAUSE
DigState
- 0 = NOTDIGGING
- 1 = PREDIG
- 2 = STARTDIG
- 3 = TUNNELING
- 4 = FINISHINGDIG
- 5 = PAUSEDIGGER
JumpState
- 0 = NOTJUMPING
- 1 = FORWARDJUMP
- 2 = PREJUMP
- 3 = UPJUMP
- 4 = APEXJUMP
- 5 = LANDJUMP
Properties
ClassName
The class name of this Entity. A string with the friendly-formatted type name of this object.
FirearmIsReady
Read-only property. Indicates whether the currently held HDFirearm is ready for use, and has ammo etc.
FirearmIsEmpty
Read-only property. Indicates whether the currently held HDFirearm is out of ammo.
FirearmNeedsReload
Read-only property. Indicates whether the currently held HDFirearm has less than half of its ammo left.
FirearmIsSemiAuto
Read-only property. Indicates whether the currently held HDFirearm is semi-auto (" = 1") or full-auto (" = 0").
Functions
ReloadFirearm
Reloads the currently held firearm, if any.
Arguments:
- None.
Return value:
None.
IsWithinRange
Tells whether a point on the scene is within close range of the currently used device and aiming status, if applicable.
Arguments:
- A Vector with the absolute coordinates of a point to check.
Return value:
Whether the point is within close range of this.
LookForMOs
Casts an MO detecting ray in the direction of where the head is looking at the time. Factors including head rotation, sharp aim mode, and other variables determine how this ray is cast.
Arguments:
- The degree angle to deviate from the current view point in the ray casting. A random ray will be chosen out of this +-range.
- A specific material ID to ignore (see through)
- Whether to ignore all terrain or not (true means 'x-ray vision').
Return value:
A pointer to the MO seen while looking.
IsOnScenePoint
Indicates whether this ACrab's current graphical representation overlaps a point given in absolute scene coordinates.
Arguments:
- The point in absolute scene coordinates.
Return value:
Whether the graphical representation overlaps the specified scene point.
