Difference between revisions of "IsChild - Location"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Terra Nova2
(Added note about this function not exactly telling the truth about rather the calling location is the parent of the passed in location. As well link to my page regarding location hierarchies.)
imported>Terra Nova
m (Undo revision 45566 by Terra Nova2 (talk))
Line 24: Line 24:
</source>
</source>


== Notes ==
* The majority of locations in the game have a hierarchy or nest of locations with TamrielLocation usually the last in this list. This function will return true even if the calling location is not the actual parent of the passed in location. In other words, if you call TamrielLocation on DawnstarLocation, it will return true, when the parent for DawnstarLocation is actually the PaleHoldLocation. And as all holds in the game have TamrielLocation as their parent location, it is concluded that this will return true for any location in the hierarchy, regardless if the calling location is not actual parent of the passed in Location.
== See Also ==
== See Also ==
*[[Location Script]]
*[[Location Script]]
*[[HasCommonParent - Location]]
*[[HasCommonParent - Location]]
*[[IsSameLocation - Location]]
*[[IsSameLocation - Location]]
*[[Location Hierarchy]]

Revision as of 02:51, 7 March 2016

Member of: Location Script

Returns if the other location is a child of this one. If they are the same location, the function returns false.

Syntax

bool Function IsChild(Location akOther) native

Parameters

  • akOther: The other location to look at.

Return Value

Returns if the other location is a child of this one.

Examples

; Is my house a child of the Batooine location?
if (BatooineProperty.IsChild(MyHouseProperty))
  Debug.Trace("My house is a child of the Batooine location")
endIf

See Also

Retrieved from "https://ck.uesp.net/w/index.php?title=IsChild_-_Location&oldid=12235"