Difference between revisions of "GetInCell"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>SJML Bot
(Bot creating condition functions pages.)
 
(Description of the function was based on Oblivion's behavior, but Skyrim doesn't work that way at all (as Skyblivion discovered).)
 
Line 4: Line 4:
   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 is the specified cell.
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:'''
'''Note:''' In previous Elder Scrolls games, this condition matched the beginning of the name. Checking <code>GetInCell Chorrol</code> would match "Chorrol", "Chorrol01", "ChorrolFarm", etc. Skyrim's version of this function '''DOES NOT''' work this way. The cell must be an ''exact'' match. This mechanism has been replaced with the location hierarchy and the [[GetInCurrentLoc]] and [[GetInCurrentLocAlias]] condition functions.
*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).  


==See Also==
==See Also==
* [[GetInSameCell]]
* [[GetInSameCell]]
* [[GetInWorldspace]]
* [[GetInWorldspace]]
*[[GetInLocation]]
* [[GetInLocation]]


==Papyrus Version==
==Papyrus Version==

Latest revision as of 23:49, 1 December 2021

Syntax:

 [ActorID.]GetInCell CellName

Example:

 GetInCell Chorrol 

Returns true if the actor's current cell is the specified cell.

Note: In previous Elder Scrolls games, this condition matched the beginning of the name. Checking GetInCell Chorrol would match "Chorrol", "Chorrol01", "ChorrolFarm", etc. Skyrim's version of this function DOES NOT work this way. The cell must be an exact match. This mechanism has been replaced with the location hierarchy and the GetInCurrentLoc and GetInCurrentLocAlias condition functions.

See Also[edit | edit source]

Papyrus Version[edit | edit source]

GetParentCell - ObjectReference