Difference between revisions of "IsSwimming"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)Functions\]\] +Category:\1Functions\nCategory:\1Functions (GECK 1.0))) |
imported>Jazzisparis |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
|CSWikiPage | |CSWikiPage = IsSwimming | ||
|origin | |origin = GECK1 | ||
|summary | |summary = Returns 1 if the calling actor is swimming, and 0 if the calling actor is not swimming. | ||
|returnType | |name = IsSwimming | ||
|referenceType | |returnVal = 0, 1 | ||
|example | |returnType = int | ||
|referenceType = [ActorRefID] | |||
|example = BuddyRef.IsSwimming | |||
}} | }} | ||
==Notes== | ==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. This approach, unlike [[IsSwimming]], will work perfectly on the player (only works for the main water body [auto-water], not for placeable water). | |||
:<pre>if GetPos Z < 10500</pre> | |||
</ | |||
==See Also== | |||
*[[IsPlayerSwimming]] | |||
*[[IsInWater]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Functions (GECK 1. | [[Category:Functions (GECK 1.1)]] | ||
[[Category:Actor State Functions]] | [[Category:Actor State Functions]] | ||
[[Category:Actor State Functions (GECK 1. | [[Category:Actor State Functions (GECK 1.1)]] | ||
[[Category:Condition Functions]] | [[Category:Condition Functions]] | ||
[[Category:Condition Functions (GECK 1. | [[Category:Condition Functions (GECK 1.1)]] | ||
Latest revision as of 20:38, 30 March 2016
< [[::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
(0, 1:int) [ActorRefID].IsSwimming
Example
BuddyRef.IsSwimming
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. This approach, unlike IsSwimming, will work perfectly on the player (only works for the main water body [auto-water], not for placeable water).
if GetPos Z < 10500