GetFlyingState - Actor

From Creation Kit
Jump to: navigation, search

Member of: Actor Script

Gets the current flying state of this actor, or, if they are riding a flying mount, the fly state of the mount.

Syntax

int Function GetFlyingState() native

Parameters

None

Return Value

The current flying state of the actor (or its flying mount), which may be one of the following:

  • 0: Not flying
  • 1: Taking off
  • 2: Cruising
  • 3: Hovering
  • 4: Landing
  • 5: Perching

Examples

; Is the dragon hovering?
if (Dragon.GetFlyingState() == 3)
  Debug.Trace("The dragon is currently hovering")
endIf

See Also