Difference between revisions of "GetInCell"
Jump to navigation
Jump to search
imported>Khadir (Documenting actor functions ...) |
imported>QQuix (Clarifying the required use of EditorIDs) |
||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
'''Syntax:''' | '''Syntax:''' | ||
[''ActorID''.]GetInCell '' | [''ActorID''.]GetInCell ''CellID'' | ||
'''Example:''' | '''Example:''' | ||
GetInCell Chorrol | GetInCell Chorrol | ||
Returns true if the actor's current cell includes " | 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_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 15: | Line 16: | ||
[[Category: Functions]] | [[Category: Functions]] | ||
[[Category:Functions (CS)]] | |||
[[Category: Functions (CS 1.0)]] | |||
[[Category:Actor Functions]] | |||
[[Category:Actor Functions (CS 1.0)]] | |||
[[Category: Actor State Functions]] | [[Category: Actor State Functions]] | ||
[[Category: Actor State Functions (CS 1.0)]] | |||
[[Category: Condition Functions]] | [[Category: Condition Functions]] | ||
[[Category: Condition Functions (CS 1.0)]] | |||
<!-- Begin Search Terms | |||
Get | |||
In | |||
Cell | |||
End Search Terms --> | |||
Latest revision as of 21: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]