Difference between revisions of "GetInCurrentLocAlias"
Jump to navigation
Jump to search
imported>Thingy Person |
(Add my findings about how this condition function behaves when filling an alias, specifically that it will match on either current or persistence locations. Also add links to Location Alias and Reference Alias.) |
||
| Line 1: | Line 1: | ||
[[GetInCurrentLocAlias]] returns TRUE if the reference's current [[Location]] is (or has a parent location of) the supplied alias. If run on a location, returns TRUE if the parent of the location is (or has a parent location of) the supplied alias. | [[GetInCurrentLocAlias]] returns TRUE if the reference's current [[Location]] is (or has a parent location of) the supplied [[Location Alias|alias]]. If run on a location, returns TRUE if the parent of the location is (or has a parent location of) the supplied alias. | ||
When you use <code>GetInCurrentLocAlias</code> to fill a [[Reference Alias]], be aware that a reference's current ''actual'' location as well as its [[Reference#Persist_Location|''persistence location'']], if it has one, will be considered. | |||
For example, if you have a Location Alias named <code>Whiterun</code> that is filled with <code>WhiterunLocation</code>, and if an Actor is currently in Markarth but has a persistence location of <code>WhiterunLocation</code>, then <code>GetInCurrentLocAlias WhiterunLocation</code> will match the Actor when the player is in ''either'' Markarth or Whiterun. | |||
==See Also== | ==See Also== | ||
Revision as of 21:33, 21 November 2023
GetInCurrentLocAlias returns TRUE if the reference's current Location is (or has a parent location of) the supplied alias. If run on a location, returns TRUE if the parent of the location is (or has a parent location of) the supplied alias.
When you use GetInCurrentLocAlias to fill a Reference Alias, be aware that a reference's current actual location as well as its persistence location, if it has one, will be considered.
For example, if you have a Location Alias named Whiterun that is filled with WhiterunLocation, and if an Actor is currently in Markarth but has a persistence location of WhiterunLocation, then GetInCurrentLocAlias WhiterunLocation will match the Actor when the player is in either Markarth or Whiterun.