GetMatchingLocations function - Game script

Found in:

Vanilla

Location[]functionGetMatchingLocations(LocationParentLocation=NONE, Keyword[]WantedKeywords=NONE, Keyword[]UnwantedKeywords=NONE, LocationRefType[]WantedRefTypes=NONE, LocationRefType[]UnwantedRefTypes=NONE, boolMustFindAllWantedKeywords=true, boolMustNotFindAnyUnwantedKeywords=true, boolMustFindAllWantedRefTypes=true, boolMustNotFindAnyUnwantedRefTypes=true, intLimitOfLocationsToReturn=0)NativeGlobal

Description

Documentation Comment

Returns a list of locations matching the following criteria
ParentLocation - if not none, returns only locations which have this as a parent location
WantedKeywords - if not empty, locations must have these keywords
UnwantedKeywords - if not empty, locations must not have these keywords
WantedRefTypes - if not empty, locations must have references with these LocationRefTypes
UnwantedRefTypes - if not empty, locations must not have these RefTypes
MustFindAllWantedKeywords - if true, locations must have ALL of the keywords. If false, location must have AT LEAST ONE of the keywords
MustNotFindAnyUnwantedKeywords - if true, locations must not have ANY of the keywords. If false, location must not have ALL of the keywords present at the same time
MustFindAllWantedRefTypes - if true, locations must have ALL of the RefTypes. If false, location must have AT LEAST ONE of the RefTypes
MustNotFindAnyUnwantedRefTypes - if true, locations must not have ANY of the RefTypes. If false, location must not have ALL of the RefTypes present at the same time
LimitOfLocationsToReturn - if > 0, randomly select this many locations to return. If <= 0, return all matching locations

Parameters

LocationParentLocation=NONE
Keyword[]WantedKeywords=NONE
Keyword[]UnwantedKeywords=NONE
LocationRefType[]WantedRefTypes=NONE
LocationRefType[]UnwantedRefTypes=NONE
boolMustFindAllWantedKeywords=true
boolMustNotFindAnyUnwantedKeywords=true
boolMustFindAllWantedRefTypes=true
boolMustNotFindAnyUnwantedRefTypes=true
intLimitOfLocationsToReturn=0

Examples

Auto-Generated Example

Location myLocation__ParentLocation
Keyword[] myKeywordArray__WantedKeywords
Keyword[] myKeywordArray__UnwantedKeywords
LocationRefType[] myLocationRefTypeArray__WantedRefTypes
LocationRefType[] myLocationRefTypeArray__UnwantedRefTypes
bool myBool__MustFindAllWantedKeywords
bool myBool__MustNotFindAnyUnwantedKeywords
bool myBool__MustFindAllWantedRefTypes
bool myBool__MustNotFindAnyUnwantedRefTypes
int myInt__LimitOfLocationsToReturn

Location[] returnedValue = Game.GetMatchingLocations(myLocation__ParentLocation, myKeywordArray__WantedKeywords, myKeywordArray__UnwantedKeywords, myLocationRefTypeArray__WantedRefTypes, myLocationRefTypeArray__UnwantedRefTypes, myBool__MustFindAllWantedKeywords, myBool__MustNotFindAnyUnwantedKeywords, myBool__MustFindAllWantedRefTypes, myBool__MustNotFindAnyUnwantedRefTypes, myInt__LimitOfLocationsToReturn)