root/org.magiclib.bounty/ActiveBounty

ActiveBounty

class ActiveBounty

Represents a bounty that has been at least viewed by the player. Can be considered an inflated/instantiated version of MagicBountySpec.

Author

Wisp

Constructors

Link copied to clipboard
constructor(bountyKey: String, fleet: CampaignFleetAPI, fleetSpawnLocation: SectorEntityToken, presetShipIds: List<String>, spec: MagicBountySpec)

Types

Link copied to clipboard
interface BountyResult
Link copied to clipboard
enum Stage
The current stage of the bounty.

Functions

Link copied to clipboard
open fun acceptBounty(bountySource: SectorEntityToken, rewardCredits: Float, rewardReputation: Float, rewardFaction: String)
Call when the player accepts a bounty.
Link copied to clipboard
open fun addDescriptionToTextPanel(text: TextPanelAPI)
Adds the description for the bounty to a [TextPanelAPI].
open fun addDescriptionToTextPanel(text: TooltipMakerAPI, color: Color, padding: Float)
Adds the description for the bounty to a [TooltipMakerAPI].
Link copied to clipboard
open fun calculateCreditReward(preScalingMultiplier: Float, postScalingMultiplier: Float): Float
Calculates and returns the number of credits that will be awarded upon completion, if any.
Link copied to clipboard
open fun endBounty(result: ActiveBounty.BountyResult)
Finishes the bounty with the provided result.
Link copied to clipboard
Link copied to clipboard
open fun getFailureReputationPenalty(): Float
Rep penalty is the inverse of the reward, capped to -0.05.
Link copied to clipboard
open fun getFlagshipInFleet(): List<FleetMemberAPI>
Link copied to clipboard
open fun getGivingFaction(): FactionAPI
The faction that offered the bounty, if any.
Link copied to clipboard
open fun getGivingFactionTextColor(): Color
The color for the giving faction, or Misc.getTextColor() if none.
Link copied to clipboard
open fun getIntel(): MagicBountyIntel
The [MagicBountyIntel] active for this bounty, if there is any.
Link copied to clipboard
open fun getKey(): String
Link copied to clipboard
open fun getPresetShipsInFleet(): List<FleetMemberAPI>
Link copied to clipboard
Link copied to clipboard
open fun getTargetFaction(): FactionAPI
The faction targeted by the bounty, if relevant.
Link copied to clipboard
open fun getTargetFactionTextColor(): Color
The color for the target faction, or Misc.getTextColor() if none.
Link copied to clipboard
open fun hasCreditReward(): Boolean
Whether the bounty has a credit reward or not.
Link copied to clipboard
open fun hasExpiration(): Boolean
Whether the bounty expires or not.
Link copied to clipboard
Link copied to clipboard
open fun toString(): String

Properties

Link copied to clipboard
val bountyCreatedTimestamp: Long
The timestamp of when the bounty was first created (not accepted).
Link copied to clipboard
open val bountySource: SectorEntityToken
The planet/station/etc from where the bounty was accepted.
Link copied to clipboard
val captain: PersonAPI
The target captain of the bounty fleet.
Link copied to clipboard
val flagshipId: String
The id of the fleet's flagship.
Link copied to clipboard
val fleet: CampaignFleetAPI
The bounty fleet.
Link copied to clipboard
val fleetSpawnLocation: SectorEntityToken
The spawn location of the fleet.
Link copied to clipboard
open val initialBountyFleetPoints: Int
The original size of the bounty fleet in FP, before any battles.
Link copied to clipboard
open val isDespawning: Boolean
Link copied to clipboard
Link copied to clipboard
open val rewardCredits: Float
The number of credits that was promised as a reward upon completion.
Link copied to clipboard
open val rewardFaction: String
Link copied to clipboard
Link copied to clipboard
val spec: MagicBountySpec
The original bounty spec, a mirror of the json definition.
Link copied to clipboard