001package com.fs.starfarer.api.impl.campaign.ids;
002
003/**
004 * Variable names for stuff stored in memory that:
005 * 1) Generally is used more than once in code, so it's convenient to track from here.
006 * 
007 * These may or may not be used in rules.csv.
008 * 
009 * 
010 * @author Alex Mosolov
011 *
012 * Copyright 2014 Fractal Softworks, LLC
013 */
014public class MemFlags {
015
016        /**
017         * About what is on a case-by-case basis determined by rules and other flags on the fleet.
018         * This will just make a fleet with this flag periodically pursue the player and try to interact with them.
019         */
020        public static final String WILL_HASSLE_PLAYER = "$willHasslePlayer";
021        public static final String HASSLE_TYPE = "$hassleType";
022        
023        public static final String NON_HOSTILE_OVERRIDES_MAKE_HOSTILE = "$makeNonHostileTakesPriority";
024        
025        public static final String NO_HIGH_BURN_TOPOGRAPHY_READINGS = "$noHighBurnTopographyReadings";
026        
027        public static final String DO_NOT_TRY_TO_AVOID_NEARBY_FLEETS= "$doNotTryToAvoidNearbyFleets";
028        
029        public static final String LIGHT_SOURCE_OVERRIDE = "$lightSourceOverride";
030        public static final String LIGHT_SOURCE_COLOR_OVERRIDE = "$lightColorOverride";
031        
032        public static final String AUTO_OPEN_BUY_SHIPS_TAB = "$autoOpenBuyShipsTab";
033        
034        public static final String SHRINE_PILGRIM_FLEET = "$shrinePilgrimFleet";
035        public static final String ACADEMY_FLEET = "$academyFleet";
036        
037        public static final String MAY_GO_INTO_ABYSS = "$mayGoIntoAbyss";
038        public static final String TEMPORARILY_NOT_AVOIDING_ABYSSAL = "$tempNotAvoidingAbyssal";
039        public static final String AVOIDING_ABYSSAL_HYPERSPACE = "$avoidingAbyssalHyperspace";
040        
041        public static final String OFFICER_SKILL_PICKS_PER_LEVEL = "$officerSkillPicksPerLevel";
042        public static final String OFFICER_MAX_LEVEL = "$officerMaxLevel";
043        public static final String OFFICER_MAX_ELITE_SKILLS = "$officerMaxEliteSkills";
044        
045        public static final String KANTA_BLUFFS = "$kantaBluffs";
046        public static final String PLAYER_UNTRUSTWORTHY = "$untrustworthy";
047        
048        
049        public static final String GLOBAL_SENSOR_BURST_JUST_USED_IN_CURRENT_LOCATION = "$sensorBurstJustUsed";
050        public static final String JUST_DID_SENSOR_BURST = "$justDidSensorBurst";
051        public static final String JUST_TOGGLED_TRANSPONDER = "$justToggledTransponder";
052        
053        public static final String GLOBAL_INTERDICTION_PULSE_JUST_USED_IN_CURRENT_LOCATION = "$interdictionPulseJustUsed";
054        public static final String JUST_DID_INTERDICTION_PULSE = "$justDidInterdictionPulse";
055        
056        public static final String EXTRA_SENSOR_INDICATORS = "$extraSensorIndicators";
057        public static final String SENSOR_INDICATORS_OVERRIDE = "$sensorIndicatorsOverride";
058        
059        public static final String EXCEPTIONAL_SLEEPER_POD_OFFICER = "$exceptionalSleeperPodOfficer";
060        
061        public static final String SUSPECTED_AI = "$suspectedAI";
062        
063        public static final String PLAYER_ATROCITIES = "$atrocities";
064        public static final String FACTION_SATURATION_BOMBARED_BY_PLAYER = "$numTimesSatBombardedByPlayer";
065        
066        public static final String STORY_CRITICAL = "$story_critical";
067        
068        /**
069         * For stuff like the Galatia Academy, where the market is fake and doesn't have the standard buy/sell/fleet/etc
070         * interaction options.
071         */
072        public static final String MARKET_HAS_CUSTOM_INTERACTION_OPTIONS = "$hasCustomInteractionOptions";
073        
074        public static final String MARKET_CAN_ALWAYS_INCENTIVIZE_GROWTH = "$marketCanAlwaysIncentivizeGrowth";
075        
076        public static final String MARKET_EXTRA_SUSPICION = "$marketExtraSuspicion";
077        public static final String PATROL_EXTRA_SUSPICION = "$patrolExtraSuspicion";
078        
079        public static final String CAN_ONLY_BE_ENGAGED_WHEN_VISIBLE_TO_PLAYER = "$canOnlyBeEngagedWhenVisibleToPlayer";
080        
081        public static final String RECENTLY_SALVAGED = "$recentlySalvaged";
082        
083        public static final String FLEET_DO_NOT_IGNORE_PLAYER = "$cfai_doNotIgnorePlayer";
084        public static final String FLEET_IGNORES_OTHER_FLEETS = "$cfai_ignoreOtherFleets";
085        public static final String FLEET_IGNORED_BY_OTHER_FLEETS = "$cfai_ignoredByOtherFleets";
086        public static final String FLEET_IGNORED_BY_FACTION = "$cfai_ignoredByFaction";
087        
088        public static final String FLEET_PATROL_DISTANCE = "$cfai_patrolDist";
089        
090        public static final String RECENTLY_PERFORMED_RAID = "$recentlyPerformedRaid";
091        public static final String RECENTLY_RAIDED = "$recentlyRaided";
092        public static final String RECENTLY_BOMBARDED = "$recentlyBombarded";
093        
094        public static final String STATION_FLEET = "$stationFleet";
095        public static final String STATION_BASE_FLEET = "$stationBaseFleet";
096        public static final String STATION_MARKET = "$stationMarket";
097        
098        public static final String STAR_SYSTEM_IN_ANCHOR_MEMORY = "$anchor_starSystem";
099        
100        public static final String PREV_SALVAGE_SPECIAL_DATA = "$prevSalvageSpecialData";
101        public static final String SALVAGE_SPECIAL_DATA = "$salvageSpecialData";
102        public static final String SALVAGE_SEED = "$salvageSeed";
103        public static final String SALVAGE_SPEC_ID_OVERRIDE = "$salvageSpecId";
104        public static final String SALVAGE_DEBRIS_FIELD = "$salvageDebrisField";
105//      public static final String SALVAGE_DEFENDER_FACTION = "$salvageDefFaction";
106//      public static final String SALVAGE_DEFENDER_PROB = "$salvageDefProb";
107        //public static final String SALVAGE_SPEC_ID = "$salvageSpecId";
108        public static final String SALVAGE_DEFENDER_OVERRIDE = "$salvageDOv";
109        
110        public static final String ENTITY_MISSION_IMPORTANT = "$missionImportant";
111        
112        //public static final String BATTLE_CREATION_CONTEXT_SCRIPT = "$bcc_script";
113        //public static final String FLEET_INTERACTION_DIALOG_CONFIG_OVERRIDE = "$fidConifg";
114        public static final String FLEET_INTERACTION_DIALOG_CONFIG_OVERRIDE_GEN = "$fidConifgGen";
115        
116        public static final String FCM_FACTION = "$fcm_faction";
117        public static final String FCM_EVENT = "$fcm_eventRef";
118        
119        
120        public static final String FLEET_NO_MILITARY_RESPONSE = "$core_fleetNoMilitaryResponse";
121        
122        public static final String FLEET_FIGHT_TO_THE_LAST = "$core_fightToTheLast";
123        
124        public static final String FLEET_BUSY = "$core_fleetBusy";
125        /**
126         * Should only be used in conjunction with FLEET_BUSY. "busy" fleets will not be
127         * co-opted by MilitaryResponseScript, and FLEET_SPECIAL_ACTION is used to mark
128         * already "busy" fleets as being engaged in doing something specific so that
129         * they are not picked for a different action.
130         */
131        public static final String FLEET_SPECIAL_ACTION = "$core_fleetSpecialAction";
132        public static final String FLEET_MILITARY_RESPONSE = "$core_fleetMilitaryResponse";
133        
134        public static final String FLEET_CHASING_GHOST = "$core_fleetChasingGhost";
135        public static final String FLEET_NOT_CHASING_GHOST = "$core_fleetNotChasingGhost";
136        public static final String FLEET_CHASING_GHOST_RANDOM = "$core_fleetChasingGhostRandom";
137        
138        public static final String MEMORY_KEY_PATROL_ALLOW_TOFF = "$patrolAllowTOff";
139        public static final String OBJECTIVE_NON_FUNCTIONAL = "$objectiveNonFunctional";
140        public static final String MEMORY_KEY_NO_SHIP_RECOVERY = "$noShipRecovery";
141        
142        public static final String MARKET_MILITARY = "$military";
143        public static final String MARKET_PATROL = "$patrol";
144        
145        public static final String MEMORY_KEY_SOURCE_MARKET = "$sourceMarket";
146        public static final String MEMORY_KEY_PATROL_FLEET = "$isPatrol";
147        public static final String MEMORY_KEY_WAR_FLEET = "$isWarFleet";
148        public static final String MEMORY_KEY_RAIDER = "$isRaider";
149        public static final String MEMORY_KEY_CUSTOMS_INSPECTOR = "$isCustomsInspector";
150        public static final String MEMORY_KEY_TRADE_FLEET = "$isTradeFleet";
151        public static final String MEMORY_KEY_SCAVENGER = "$isScavenger";
152        public static final String MEMORY_KEY_SMUGGLER = "$isSmuggler";
153        public static final String MEMORY_KEY_PIRATE = "$isPirate";
154        public static final String MEMORY_KEY_FLEET_TYPE = "$fleetType";
155        public static final String MEMORY_KEY_FLEET_DO_NOT_GET_SIDETRACKED = "$doNotGetSidetracked";
156        
157        public static final String MEMORY_KEY_FORCE_TRANSPONDER_OFF = "$forceTOff";
158        
159        public static final String MEMORY_KEY_SKIP_TRANSPONDER_STATUS_INFO = "$skipTInfo";
160        
161        
162        
163        public static final String MEMORY_KEY_AVOID_PLAYER_SLOWLY = "$cfai_avoidPlayerSlowly";
164        public static final String MEMORY_KEY_NEVER_AVOID_PLAYER_SLOWLY = "$cfai_neverAvoidPlayerSlowly";
165        
166        public static final String MEMORY_KEY_MAKE_HOSTILE = "$cfai_makeHostile";
167        public static final String MEMORY_KEY_MAKE_HOSTILE_TO_PLAYER_TRADE_FLEETS = "$cfai_makeHostileToPlayerTradeFleets";
168        public static final String MEMORY_KEY_MAKE_HOSTILE_TO_ALL_TRADE_FLEETS = "$cfai_makeHostileToAllTradeFleets";
169        public static final String MEMORY_KEY_MAKE_HOSTILE_WHILE_TOFF = "$cfai_makeHostileWhileTOff";
170        public static final String MEMORY_KEY_MAKE_NON_HOSTILE = "$cfai_makeNonHostile";
171        public static final String MEMORY_KEY_ALLOW_PLAYER_BATTLE_JOIN_TOFF = "$cfai_allowPlayerBattleJoinTOff";
172        
173        public static final String MEMORY_KEY_MAKE_ALWAYS_PURSUE = "$cfai_makeAlwaysPursue";
174        public static final String MEMORY_KEY_MAKE_PREVENT_DISENGAGE = "$cfai_makePreventDisengage";
175        public static final String MEMORY_KEY_MAKE_ALLOW_DISENGAGE = "$cfai_makeAllowDisengage";
176        public static final String MEMORY_KEY_MAKE_AGGRESSIVE = "$cfai_makeAggressive";
177        public static final String MEMORY_KEY_MAKE_HOLD_VS_STRONGER = "$cfai_holdVsStronger";
178        public static final String MEMORY_KEY_MAKE_AGGRESSIVE_ONE_BATTLE_ONLY = "$cfai_makeAggressiveLastsOneBattle";
179        public static final String MEMORY_KEY_MAKE_NON_AGGRESSIVE = "$cfai_makeNonAggressive";
180        public static final String MEMORY_KEY_RECENTLY_DEFEATED_BY_PLAYER = "$cfai_recentlyDefeatedByPlayer";
181        public static final String MEMORY_KEY_NO_JUMP = "$cfai_noJump";
182        
183        public static final String MEMORY_KEY_ALLOW_LONG_PURSUIT = "$cfai_longPursuit";
184        
185        public static final String MEMORY_KEY_IGNORE_PLAYER_COMMS = "$ignorePlayerCommRequests";
186        
187        public static final String MEMORY_KEY_SAW_PLAYER_WITH_TRANSPONDER_OFF = "$sawPlayerTransponderOff";
188        public static final String MEMORY_KEY_SAW_PLAYER_WITH_TRANSPONDER_ON = "$sawPlayerTransponderOn";
189        
190        
191        public static final String MEMORY_KEY_PURSUE_PLAYER = "$pursuePlayer";
192        public static final String MEMORY_KEY_STICK_WITH_PLAYER_IF_ALREADY_TARGET = "$keepPursuingPlayer";
193        public static final String MEMORY_MARKET_SMUGGLING_SUSPICION_LEVEL = "$smugglingSuspicion";
194        public static final String MEMORY_KEY_PLAYER_HOSTILE_ACTIVITY_NEAR_MARKET = "$playerHostileTimeout";
195        
196        public static final String SPREAD_TOFF_HOSTILITY_IF_LOW_IMPACT = "$alwaysSpreadTOffHostility";
197        public static final String MEMORY_KEY_LOW_REP_IMPACT = "$lowRepImpact";
198        public static final String MEMORY_KEY_NO_REP_IMPACT = "$noRepImpact";
199        
200        public static final String MEMORY_KEY_EVERYONE_JOINS_BATTLE_AGAINST = "$everyoneJoinsBattleAgainst";
201//      public static final String MEMORY_KEY_NO_ONE_JOINTS_BATTLE_TO_HELP = "noOneJoinsBattleToHelp";
202        
203        public static final String MEMORY_KEY_DO_NOT_SHOW_FLEET_DESC = "$shownFleetDescAlready";
204        public static final String MEMORY_KEY_FORCE_AUTOFIT_ON_NO_AUTOFIT_SHIPS = "$overrideNoAutofit";
205        
206        public static final String MEMORY_KEY_MISSION_IMPORTANT = "$missionImportant";
207        
208        
209        /**
210         * To make a faction consider the system its territory for the purpose of sending punitive expeditions
211         * against player colonies there. 
212         */
213        public static final String CLAIMING_FACTION = "$claimingFaction";
214        
215        
216        public static final String MEMORY_KEY_NUM_GR_INVESTIGATIONS = "$numGRInvestigations";
217        public static final String MEMORY_KEY_REQUIRES_DISCRETION = "$requiresDiscretionToDeal";
218        
219        public static final String MARKET_DO_NOT_INIT_COMM_LISTINGS = "$doNotInitCommListings";
220
221        public static String HIDDEN_BASE_MEM_FLAG = "$core_hiddenBase";
222        
223        
224}
225
226
227
228
229
230
231
232
233
234