Difference between revisions of "GetInCell"

GetInCell (edit)

81 bytes added , 22:04, 2 May 2011

Clarifying the required use of EditorIDs

Anonymous user

@@ Line 1: / Line 1: @@
 '''Syntax:'''
-   [''ActorID''.]GetInCell ''CellName''
+   [''ActorID''.]GetInCell ''CellID''
 '''Example:'''
    GetInCell Chorrol
-Returns true if the actor's current cell includes "CellName" as the first part
+Returns true if the actor's current cell includes "CellID" as the first part of its EditorID (not the cell name!). Again, this not exactly "any" part of its EditorID, it has to be the first part of its EditorID ... Chorrol will match Chorrol, Chorrol01, ChorrolFarm, etc.  but using "Farm" would result in never finding ChorrolFarm.
-of its cell name. Again, this not exactly "any" part of it's name, it has to
-be the first part of it's name... Chorrol will match Chorrol, Chorrol01, ChorrolFarm, etc.  but using "Farm" would result in never finding ChorrolFarm.
 '''Notes:'''
-*The CellName has to be a valid [[Interior_cells|interior cell]] name. [[Exterior cells]] will not work. In some cases, it is necessary to create a "dummy" interior cell (e.g. Chorrol) in order to use GetInCell for a set of related interior and exterior cells (e.g. all the ChorrolXXX cells).
+*The CellID has to be a valid [[Interior_cells|interior cell]] EditorID. This function will not compile if CellID is an [[Exterior cells|Exterior cell]] EditorID. In some cases, it is necessary to create a "dummy" interior cell (e.g. Chorrol) in order to use GetInCell for a set of related interior and exterior cells (e.g. all the ChorrolXXX cells).
 ==See Also==