Difference between revisions of "GetInCell"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(Category links)
imported>QQuix
(Clarifying the required use of EditorIDs)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''Syntax:'''
'''Syntax:'''
   [''ActorID''.]GetInCell ''CellName''
   [''ActorID''.]GetInCell ''CellID''
'''Example:'''
'''Example:'''
   GetInCell Chorrol  
   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:'''
'''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==
==See Also==
Line 17: Line 16:


[[Category: Functions]]
[[Category: Functions]]
[[Category:Functions (CS)]]
[[Category: Functions (CS 1.0)]]
[[Category: Functions (CS 1.0)]]
[[Category:Actor Functions]]
[[Category:Actor Functions]]
Line 24: Line 24:
[[Category: Condition Functions]]
[[Category: Condition Functions]]
[[Category: Condition Functions (CS 1.0)]]
[[Category: Condition Functions (CS 1.0)]]
<!-- Begin Search Terms
Get
In
Cell
End Search Terms -->

Latest revision as of 22:04, 2 May 2011

Syntax:

 [ActorID.]GetInCell CellID

Example:

 GetInCell Chorrol 

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.

Notes:

  • The CellID has to be a valid interior cell EditorID. This function will not compile if CellID is an 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[edit | edit source]