root/org.magiclib.bounty/MagicBountySpec

MagicBountySpec

The code representation of a bounty json definition.

Constructors

constructor(trigger_market_id: List<String>, trigger_marketFaction_any: List<String>, trigger_marketFaction_alliedWith: Boolean, trigger_marketFaction_none: List<String>, trigger_marketFaction_enemyWith: Boolean, trigger_market_minSize: Int, trigger_player_minLevel: Int, trigger_min_days_elapsed: Int, trigger_min_fleet_size: Int, trigger_weight_mult: Float, trigger_memKeys_all: Map<String, Boolean>, trigger_memKeys_any: Map<String, Boolean>, trigger_memKeys_none: Map<String, Boolean>, trigger_playerRelationship_atLeast: Map<String, Float>, trigger_playerRelationship_atMost: Map<String, Float>, trigger_giverTargetRelationship_atLeast: Float, trigger_giverTargetRelationship_atMost: Float, job_name: String, job_description: String, job_comm_reply: String, job_intel_success: String, job_intel_failure: String, job_intel_expired: String, job_forFaction: String, job_difficultyDescription: String, job_deadline: Int, job_credit_reward: Int, job_credit_scaling: Float, job_reputation_reward: Float, job_item_reward: Map<String, Integer>, job_type: String, job_show_type: Boolean, job_show_captain: Boolean, job_show_fleet: String, job_show_distance: String, job_show_arrow: Boolean, job_pick_option: String, job_pick_script: String, job_memKey: String, job_conclusion_script: String, existing_target_memkey: String, target_importantPersonId: String, target_first_name: String, target_last_name: String, target_portrait: String, target_gender: Gender, target_rank: String, target_post: String, target_personality: String, target_aiCoreId: String, target_level: Int, target_elite_skills: Int, target_skill_preference: SkillPickPreference, target_skills: Map<String, Integer>, fleet_name: String, fleet_faction: String, fleet_flagship_variant: String, fleet_flagship_name: String, fleet_flagship_alwaysRecoverable: Boolean, fleet_flagship_autofit: Boolean, fleet_preset_ships: Map<String, Integer>, fleet_preset_autofit: Boolean, fleet_scaling_multiplier: Float, fleet_min_FP: Int, fleet_composition_faction: String, fleet_composition_quality: Float, fleet_transponder: Boolean, fleet_no_retreat: Boolean, fleet_behavior: FleetAssignment, fleet_musicSetId: String, location_marketIDs: List<String>, location_marketFactions: List<String>, location_distance: String, location_themes: List<String>, location_themes_blacklist: List<String>, location_entities: List<String>, location_prioritizeUnexplored: Boolean, location_defaultToAnyEntity: Boolean)

Functions

toString

open fun toString(): String

Properties

existing_target_memkey

open var existing_target_memkey: String

existing fleet if non empty, the bounty will be placed on the existing fleet with that memkey.

fleet_behavior

open var fleet_behavior: FleetAssignment

PASSIVE, GUARDED, AGGRESSIVE, ROAMING, default to GUARDED (campaign.FleetAssignment.

fleet_composition_faction

open var fleet_composition_faction: String

Faction of the extra ship, can be different from the bounty faction (in case of pirate deserters for example)

fleet_composition_quality

open var fleet_composition_quality: Float

default to 2 (no Dmods) if <0

fleet_faction

open var fleet_faction: String

faction of the fleet once it is generated, but not necessarily the faction of the ships inside

fleet_flagship_alwaysRecoverable

open var fleet_flagship_alwaysRecoverable: Boolean

fleet_flagship_autofit

open var fleet_flagship_autofit: Boolean

if false the weapons won't get changed, but no D-mod will be added at low quality either

fleet_flagship_name

open var fleet_flagship_name: String

fleet_flagship_variant

open var fleet_flagship_variant: String

fleet_min_FP

open var fleet_min_FP: Int

fleet_musicSetId

open var fleet_musicSetId: String

The musicSetId to use for the fleet, default to the faction's default music set.

fleet_name

open var fleet_name: String

bounty fleet

fleet_no_retreat

open var fleet_no_retreat: Boolean

default to false, prevents the enemy from retreating

fleet_preset_autofit

open var fleet_preset_autofit: Boolean

if false the weapons won't get changed, but no D-mod will be added at low quality either

fleet_preset_ships

open var fleet_preset_ships: Map<String, Integer>

optional preset fleet generated with the flagship, [variantId:number_of_ships]

fleet_scaling_multiplier

open var fleet_scaling_multiplier: Float

dynamic reinforcements to match that amount of player fleet DP, set to 0 to ignore

fleet_transponder

open var fleet_transponder: Boolean

job_comm_reply

open var job_comm_reply: String

Reply of the enemy to your hail, default to "The other $shipOrFleet does not answer to you hails.

job_conclusion_script

open var job_conclusion_script: String

optional, can be used to give additional rewards or add further consequences in case of failure using memkeys to check the outcome

job_credit_reward

open var job_credit_reward: Int

job_credit_scaling

open var job_credit_scaling: Float

only used with fleet scaling: total reward = job_credits_reward * (job_reward_scaling * (bounty fleet DP / fleet_minimal_DP) )

job_deadline

open var job_deadline: Int

job_description

open var job_description: String

Full text of the bounty offer.

job_difficultyDescription

open var job_difficultyDescription: String

"none": no description, "auto": bounty board describes how dangerous the bounty is, any other text: bounty board displays the text

job_forFaction

open var job_forFaction: String

successfully completing this mission with give a small reputation reward with this faction

job_intel_expired

open var job_intel_expired: String

short text added to the Intel object after the job has been left to expire

job_intel_failure

open var job_intel_failure: String

short text added to the Intel object after the job has been failed

job_intel_success

open var job_intel_success: String

short text added to the Intel object after the job has been successfully completed

job_item_reward

open var job_item_reward: Map<String, Integer>

job_memKey

open var job_memKey: String

optional, MemKey set to false is added when accepting the job, set to true if the job is sucessful

job_name

open var job_name: String

job name in the dialog pick list

job_pick_option

open var job_pick_option: String

dialog text to pick the job

job_pick_script

open var job_pick_script: String

optional, can be used to trigger further scripts when the mission is taken, for example you may want to have competing bounty hunters

job_reputation_reward

open var job_reputation_reward: Float

job_show_arrow

open var job_show_arrow: Boolean

job_show_captain

open var job_show_captain: Boolean

job_show_distance

open var job_show_distance: ShowDistance

how precisely the distance to the target is shown on the bounty board.

job_show_fleet

open var job_show_fleet: ShowFleet

how much of the fleet to show on the bounty board.

job_show_type

open var job_show_type: Boolean

assassination: requires only to disable the flagship destruction: requires the complete destruction of the flagship without recovery obliteration: requires the complete destruction or disabling of the enemy fleet neutralisation: requires the destruction or disabling of 2/3rd of the enemy fleet default to assassination

job_type

open var job_type: JobType

assassination, destruction, obliteration, neutralization

location_defaultToAnyEntity

open var location_defaultToAnyEntity: Boolean

if true and no suitable entity is found in systems with required themes and distance, a random entity will be picked instead.

location_distance

open var location_distance: String

prefered distance, "CORE", "CLOSE" or "FAR".

location_entities

open var location_entities: List<String>

PLANET, GATE, STATION, STABLE_LOCATION, DEBRIS, WRECK, PROBE.

location_marketFactions

open var location_marketFactions: List<String>

takes precedence over all other parameters but market ids

location_marketIDs

open var location_marketIDs: List<String>

Preset locations (SectorEntityTokens, not markets, variable is poorly named) to spawn the bounty fleet, will fall back to other choices (if they are defined) and if this preset location doesn't exist (eg due to Nexerelin's random mode).

location_prioritizeUnexplored

open var location_prioritizeUnexplored: Boolean

will pick in priority systems that have not been visited by the player yet, but won't override the distance requirements

location_themes

open var location_themes: List<String>

campaign.ids.

location_themes_blacklist

open var location_themes_blacklist: List<String>

target_aiCoreId

open var target_aiCoreId: String

if properly set, turn the target into a AI, makes it drop AI cores

target_elite_skills