root/org.magiclib.util/MagicCampaign/findSuitableTarget

findSuitableTarget

open fun findSuitableTarget(entityIDs: List<String>, marketFactions: List<String>, distance: String, seek_themes: List<String>, avoid_themes: List<String>, entities: List<String>, defaultToAnyEntity: Boolean, prioritizeUnexplored: Boolean, verbose: Boolean): SectorEntityToken

Returns a random target SectorEntityToken given the following parameters:

Return

Parameters

entityIDs

List of IDs of preferred markets to target, supercedes all, default to other parameters if none of those markets exist

marketFactions

List of faction to pick a market from, supercedes all but market ids, default to other parameters if none of those markets exist

distance

"CORE", "CLOSE", "FAR", preferred range band for the target system if any

seek_themes

List of preferred system themes TAGS from campaign.ids.Tags, plus "PROCGEN_NO_THEME" and "PROCGEN_NO_THEME_NO_PULSAR_NO_BLACKHOLE"

avoid_themes

List of blacklisted system themes

entities

List of preferred entity types from campaign.ids.Tags

defaultToAnyEntity

If none of the systems in the required range band has any of the required entities, will the script default to any entity within a system with the proper range and themes instead of looking into a different range band

prioritizeUnexplored

Will the script target unexplored systems first before falling back to ones that have been visited by the player

verbose

Log some debug messages