Difference between revisions of "GetInCurrentLocAlias"
Jump to navigation
Jump to search
m (Correct a small error in my example) |
(Corrected an error saying that the Actor would be matched in Markarth when tested against an alias containing their persistence location only. The statement as written was the behavior I observed but the test condition was against an alias that was filled with the player's current location.) Tags: Mobile web edit Mobile edit |
||
| Line 3: | Line 3: | ||
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. | 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>WhiterunAlias</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 WhiterunAlias</code> will match the Actor | For example, if you have a Location Alias named <code>WhiterunAlias</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 WhiterunAlias</code> will match the Actor, even though the Actor is actually in Markarth. | ||
==See Also== | ==See Also== | ||
Latest revision as of 08:14, 24 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 WhiterunAlias that is filled with WhiterunLocation, and if an Actor is currently in Markarth but has a persistence location of WhiterunLocation, then GetInCurrentLocAlias WhiterunAlias will match the Actor, even though the Actor is actually in Markarth.