Difference between revisions of "GetInSameCell"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-Link to TES4 Construction Set Wiki +{{Incomplete}}\n\nLink to TES4 Construction Set Wiki)) |
imported>Odessa (note on exteriors, and getingrid) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{Function | ||
|CSWikiPage = GetInSameCell | |||
|origin = GECK1 | |||
|summary = Returns true if the [[calling reference]] is in the same cell as the target Actor. | |||
|name = GetInSameCell | |||
|returnVal = | |||
|returnType = bool | |||
|referenceType = Actor | |||
|arguments = | |||
{{FunctionArgument | |||
|Name = Target | |||
|Type = Actor | |||
}} | |||
|example =<pre>BuddyRef.GetInSameCell player</pre> | |||
This will return a 1 if Buddy is in the same cell as the player, and 0 otherwise. | |||
}} | |||
==Notes== | |||
*This function may give unexpected results if used in exteriors, as it will return false if two adjacent actors are seperated by a cell boundary. Consider using [[GetInGrid]] instead. | |||
== | ==See Also== | ||
[[GetInCell]] | *[[GetInCell]] | ||
*[[GetInGrid]] | |||
*[[IsInInterior]] | |||
[[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)]] | |||
Latest revision as of 11:30, 25 November 2014
< [[::Category:Functions|Category:Functions]]
Link to TES4 Construction Set Wiki: GetInSameCell.
A function included in the GECK version 1.1.0.36.
Description
Returns true if the calling reference is in the same cell as the target Actor.
Syntax
(bool) Actor.GetInSameCell Target:Actor
Example
BuddyRef.GetInSameCell player
This will return a 1 if Buddy is in the same cell as the player, and 0 otherwise.
Notes
- This function may give unexpected results if used in exteriors, as it will return false if two adjacent actors are seperated by a cell boundary. Consider using GetInGrid instead.