root/org.magiclib.campaign/MagicCaptainBuilder

MagicCaptainBuilder

open class MagicCaptainBuilder

Creates a captain PersonAPI.

Not all fields are required. Each `set` method has a comment showing the default value for if it is not used.

Usage: 

MagicCampaign.createCaptainBuilder(Factions.LUDDIC_CHURCH)
            .setFirstName("David")
            .setLastName("Rengel")
            .setGender(FullName.Gender.MALE)
            .create();
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(factionId: String)

Functions

Link copied to clipboard
open fun create(): PersonAPI
Link copied to clipboard
open fun setAICoreType(aiCoreType: String): MagicCaptainBuilder
AI core from campaign.ids.Commodities.
Link copied to clipboard
open fun setEliteSkillsOverride(eliteSkillsOverride: Integer): MagicCaptainBuilder
Overrides the regular number of elite skills, set to -1 to ignore.
Link copied to clipboard
open fun setFactionId(factionId: String): MagicCaptainBuilder
Link copied to clipboard
open fun setFirstName(firstName: String): MagicCaptainBuilder
Default: randomly chosen from faction names.
Link copied to clipboard
open fun setGender(gender: Gender): MagicCaptainBuilder
Default: Randomly chosen between male and female if non-AI.
Link copied to clipboard
open fun setIsAI(isAI: Boolean): MagicCaptainBuilder
Default: false.
Link copied to clipboard
open fun setLastName(lastName: String): MagicCaptainBuilder
Default: randomly chosen from faction names.
Link copied to clipboard
open fun setLevel(level: Integer): MagicCaptainBuilder
Captain level, picks random skills according to the faction's doctrine.
Link copied to clipboard
open fun setPersonality(personality: String): MagicCaptainBuilder
Personality from campaign.ids.Personalities.
Link copied to clipboard
open fun setPortraitId(portraitId: String): MagicCaptainBuilder
Id of the sprite in settings.json/graphics/characters.
Link copied to clipboard
open fun setPostId(postId: String): MagicCaptainBuilder
Default: Ranks.POST_FLEET_COMMANDER.
Link copied to clipboard
open fun setRankId(rankId: String): MagicCaptainBuilder
Default: Ranks.SPACE_COMMANDER.
Link copied to clipboard
open fun setSkillLevels(skillLevels: Map<String, Integer>): MagicCaptainBuilder
Map Optional skills from campaign.ids.Skills and their appropriate levels, OVERRIDES ALL RANDOM SKILLS PREVIOUSLY PICKED.
Link copied to clipboard
open fun setSkillPreference(skillPreference: SkillPickPreference): MagicCaptainBuilder
GENERIC, PHASE, CARRIER, ANY from OfficerManagerEvent.SkillPickPreference.