Difference between revisions of "GetInSameCell"

GetInSameCell (edit)

677 bytes added , 12:30, 25 November 2014

note on exteriors, and getingrid

Anonymous user

@@ Line 1: / Line 1: @@
-Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/GetInSameCell GetInSameCell].
+{{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.
+}}
-=='''See Also'''==
+==Notes==
-[[GetInCell]]<br>
+*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]]
+*[[GetInGrid]]
+*[[IsInInterior]]
 [[Category:Functions]]
+[[Category:Functions (GECK 1.1)]]
 [[Category:Actor State Functions]]
+[[Category:Actor State Functions (GECK 1.1)]]
 [[Category:Condition Functions]]
+[[Category:Condition Functions (GECK 1.1)]]