Difference between revisions of "GetInSameCell"
Jump to navigation
Jump to search
imported>PoHa! (copied info; used the template for functions) |
imported>Odessa (note on exteriors, and getingrid) |
||
| Line 2: | Line 2: | ||
|CSWikiPage = GetInSameCell | |CSWikiPage = GetInSameCell | ||
|origin = GECK1 | |origin = GECK1 | ||
|summary = Returns true if the calling reference is in the same cell as the target Actor | |summary = Returns true if the [[calling reference]] is in the same cell as the target Actor. | ||
|name = GetInSameCell | |name = GetInSameCell | ||
|returnVal = | |returnVal = | ||
|returnType = | |returnType = bool | ||
|referenceType = | |referenceType = Actor | ||
|arguments = | |arguments = | ||
{{FunctionArgument | {{FunctionArgument | ||
| Line 13: | Line 13: | ||
}} | }} | ||
|example =<pre>BuddyRef.GetInSameCell player</pre> | |example =<pre>BuddyRef.GetInSameCell player</pre> | ||
This will return a 1 if Buddy is in the same cell as the player, and 0 otherwise | This will return a 1 if Buddy is in the same cell as the player, and 0 otherwise. | ||
}} | }} | ||
==Notes== | ==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== | ==See Also== | ||
*[[GetInCell]] | *[[GetInCell]] | ||
*[[GetInGrid]] | |||
*[[IsInInterior]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
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.