IsSwimming

Revision as of 13:09, 12 August 2009 by imported>Geckbot (Robot: Automated text replacement (-\[\[Category:(.*?)Functions\]\] +Category:\1Functions\nCategory:\1Functions (GECK 1.0)))
< [[::Category:Functions|Category:Functions]]

Link to TES4 Construction Set Wiki: IsSwimming.

A function included in the GECK version 1.1.0.36.

Description

Returns 1 if the calling actor is swimming, and 0 if the calling actor is not swimming.

Syntax

(int) Actor.IsSwimming

Example

BuddyRef.IsSwimming

Returns 1 if BuddyRef is swimming, and 0 if BuddyRef is not swimming.

Notes

  • IsSwimming will always return 0 if called on the player.
  • If the calling actor is in the Wasteland worldspace, whether or not they are swimming can be determined by checking their Z coordinate:
    if GetPos Z < 10500

    Note that this approach, unlike IsSwimming, will work perfectly on the player.