Difference between revisions of "IsSwimming"

128 bytes added ,  20:38, 30 March 2016
no edit summary
imported>Cipscis
(Updated to use function template, added notes about player bug and workaround)
imported>Jazzisparis
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function
{{Function
  |CSWikiPage       = IsSwimming
  |CSWikiPage = IsSwimming
  |origin           = GECK1
  |origin = GECK1
  |summary           = Returns 1 if the calling actor is swimming, and 0 if the calling actor is not swimming.
  |summary = Returns 1 if the calling actor is swimming, and 0 if the calling actor is not swimming.
  |returnType       = int
|name = IsSwimming
  |referenceType     = Actor
|returnVal = 0, 1
  |example           = BuddyRef.IsSwimming
  |returnType = int
Returns 1 if BuddyRef is swimming, and 0 if BuddyRef is not swimming.
  |referenceType = [ActorRefID]
  |example = BuddyRef.IsSwimming
}}
}}
==Notes==
==Notes==
<ul>
*[[IsSwimming]] will always return 0 if called on the player.
<li>
*If the calling actor is in the Wasteland worldspace, whether or not they are swimming can be determined by checking their Z coordinate. This approach, unlike [[IsSwimming]], will work perfectly on the player (only works for the main water body [auto-water], not for placeable water).
[[IsSwimming]] will always return 0 if called on the player.
:<pre>if GetPos Z < 10500</pre>
</li>
<li>
If the calling actor is in the Wasteland worldspace, whether or not they are swimming can be determined by checking their Z coordinate:
<pre>if GetPos Z < 10500</pre>
Note that this approach, unlike [[IsSwimming]], will work perfectly on the player.
</li>
</ul>
 


==See Also==
*[[IsPlayerSwimming]]
*[[IsInWater]]
[[Category:Functions]]
[[Category:Functions]]
[[Category:Functions (GECK 1.1)]]
[[Category:Actor State Functions]]
[[Category:Actor State Functions]]
[[Category:Actor State Functions (GECK 1.1)]]
[[Category:Condition Functions]]
[[Category:Condition Functions]]
[[Category:Condition Functions (GECK 1.1)]]
Anonymous user