Difference between revisions of "IsInLocation - ObjectReference"
Jump to navigation
Jump to search
imported>Jlundin |
imported>Thingy Person (→Syntax) |
||
| Line 8: | Line 8: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
bool Function IsInLocation(Location akLocation) | bool Function IsInLocation(Location akLocation) | ||
Location currLoc = GetCurrentLocation() | |||
if currLoc == None | |||
return false | |||
else | |||
return akLocation.IsChild(currLoc) || currLoc == akLocation | |||
endif | |||
endFunction | |||
</source> | </source> | ||
Revision as of 17:04, 29 June 2013
Member of: ObjectReference Script
Checks to see if this object is in the specified location, or a child of the specified location.
Syntax
bool Function IsInLocation(Location akLocation)
Location currLoc = GetCurrentLocation()
if currLoc == None
return false
else
return akLocation.IsChild(currLoc) || currLoc == akLocation
endif
endFunctionParameters
- akLocation: The Location to check.
Return Value
Whether this reference is in the specified location.
Examples
; Is the box in the house location?
if Box.IsInLocation(House)
Debug.Trace("Box is in the house!")
endIf