|
Barotrauma Client Doc
|
Public Types | |
| enum class | InfoFrameTab { Crew , Mission , MyCharacter , Traitor } |
Public Member Functions | |
| GameSession (SubmarineInfo submarineInfo, string savePath, GameModePreset gameModePreset, CampaignSettings settings, string? seed=null, MissionType missionType=MissionType.None) | |
| Start a new GameSession. Will be saved to the specified save path (if playing a game mode that can be saved). More... | |
| GameSession (SubmarineInfo submarineInfo, GameModePreset gameModePreset, string? seed=null, IEnumerable< MissionPrefab >? missionPrefabs=null) | |
| Start a new GameSession with a specific pre-selected mission. More... | |
| GameSession (SubmarineInfo submarineInfo, List< SubmarineInfo > ownedSubmarines, XDocument doc, string saveFile) | |
| Load a game session from the specified XML document. The session will be saved to the specified path. More... | |
| void | LoadPreviousSave () |
| void | SwitchSubmarine (SubmarineInfo newSubmarine, bool transferItems, Client? client=null) |
| Switch to another submarine. The sub is loaded when the next round starts. More... | |
| bool | TryPurchaseSubmarine (SubmarineInfo newSubmarine, Client? client=null) |
| bool | IsSubmarineOwned (SubmarineInfo query) |
| bool | IsCurrentLocationRadiated () |
| void | StartRound (string levelSeed, float? difficulty=null, LevelGenerationParams? levelGenerationParams=null) |
| void | StartRound (LevelData? levelData, bool mirrorLevel=false, SubmarineInfo? startOutpost=null, SubmarineInfo? endOutpost=null) |
| void | PlaceSubAtStart (Level? level) |
| void | Update (float deltaTime) |
| Mission? | GetMission (int index) |
| int | GetMissionIndex (Mission mission) |
| void | EnforceMissionOrder (List< Identifier > missionIdentifiers) |
| void | EndRound (string endMessage, CampaignMode.TransitionType transitionType=CampaignMode.TransitionType.None, TraitorManager.TraitorResults? traitorResults=null) |
| void | LogEndRoundStats (string eventId, TraitorManager.TraitorResults? traitorResults=null) |
| void | KillCharacter (Character character) |
| void | ReviveCharacter (Character character) |
| void | Save (string filePath) |
| bool | ToggleTabMenu () |
| void | AddToGUIUpdateList () |
| void | EnableEventLogNotificationIcon (bool enabled) |
| void | HUDScaleChanged () |
| void | SetRespawnInfo (bool visible, string text, Color textColor, bool buttonsVisible, bool waitForNextRoundRespawn) |
| void | Draw (SpriteBatch spriteBatch) |
Static Public Member Functions | |
| static Location[] | CreateDummyLocations (LevelData levelData, LocationType? forceLocationType=null) |
| static Location[] | CreateDummyLocations (string seed, LocationType? forceLocationType=null) |
| static ImmutableHashSet< Character > | GetSessionCrewCharacters (CharacterType type) |
| Returns a list of crew characters currently in the game with a given filter. More... | |
| static bool | IsCompatibleWithEnabledContentPackages (IList< string > contentPackageNames, out LocalizedString errorMsg) |
| static GUIImage | CreateNotificationIcon (GUIComponent parent, bool offset=true) |
| static void | UpdateTalentNotificationIndicator (GUIImage indicator) |
Public Attributes | |
| readonly EventManager | EventManager |
| GameMode? | GameMode |
| CrewManager? | CrewManager |
| double | TimeSpentCleaning |
| CharacterTeamType? | WinningTeam |
| List< SubmarineInfo > | OwnedSubmarines = new List<SubmarineInfo>() |
Properties | |
| Version | LastSaveVersion = GameMain.Version [get, set] |
| float | RoundDuration [get] |
| IEnumerable< Mission > | Missions [get] |
| IEnumerable< Character > | Casualties [get] |
| bool | IsRunning [get] |
| bool | RoundEnding [get] |
| Level? | Level [get] |
| LevelData? | LevelData [get] |
| bool | MirrorLevel [get] |
| Map?? | Map [get] |
| CampaignMode? | Campaign [get] |
| Location? | StartLocation [get] |
| Location? | EndLocation [get] |
| SubmarineInfo | SubmarineInfo [get, set] |
| Submarine? | Submarine [get, set] |
| string? | SavePath [get, set] |
| bool | TraitorsEnabled [get] |
| RoundSummary | RoundSummary [get] |
| static bool | IsTabMenuOpen [get] |
| static TabMenu | TabMenuInstance [get] |
Definition at line 16 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
strong |
| Enumerator | |
|---|---|
| Crew | |
| Mission | |
| MyCharacter | |
| Traitor | |
Definition at line 22 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| Barotrauma.GameSession.GameSession | ( | SubmarineInfo | submarineInfo, |
| string | savePath, | ||
| GameModePreset | gameModePreset, | ||
| CampaignSettings | settings, | ||
| string? | seed = null, |
||
| MissionType | missionType = MissionType.None |
||
| ) |
Start a new GameSession. Will be saved to the specified save path (if playing a game mode that can be saved).
Definition at line 129 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| Barotrauma.GameSession.GameSession | ( | SubmarineInfo | submarineInfo, |
| GameModePreset | gameModePreset, | ||
| string? | seed = null, |
||
| IEnumerable< MissionPrefab >? | missionPrefabs = null |
||
| ) |
Start a new GameSession with a specific pre-selected mission.
Definition at line 141 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| Barotrauma.GameSession.GameSession | ( | SubmarineInfo | submarineInfo, |
| List< SubmarineInfo > | ownedSubmarines, | ||
| XDocument | doc, | ||
| string | saveFile | ||
| ) |
Load a game session from the specified XML document. The session will be saved to the specified path.
Definition at line 152 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.AddToGUIUpdateList | ( | ) |
Definition at line 123 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
|
static |
Definition at line 267 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
static |
Definition at line 294 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
static |
Definition at line 152 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.Draw | ( | SpriteBatch | spriteBatch | ) |
Definition at line 242 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.EnableEventLogNotificationIcon | ( | bool | enabled | ) |
Definition at line 167 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.EndRound | ( | string | endMessage, |
| CampaignMode.TransitionType | transitionType = CampaignMode.TransitionType.None, |
||
| TraitorManager.TraitorResults? | traitorResults = null |
||
| ) |
Definition at line 875 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.EnforceMissionOrder | ( | List< Identifier > | missionIdentifiers | ) |
Definition at line 817 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| Mission? Barotrauma.GameSession.GetMission | ( | int | index | ) |
Definition at line 806 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| int Barotrauma.GameSession.GetMissionIndex | ( | Mission | mission | ) |
Definition at line 812 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
static |
Returns a list of crew characters currently in the game with a given filter.
| type | Character type filter |
In singleplayer mode the CharacterType.Player returns the currently controlled player.
Definition at line 840 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.HUDScaleChanged | ( | ) |
Definition at line 185 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
|
static |
Definition at line 1113 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| bool Barotrauma.GameSession.IsCurrentLocationRadiated | ( | ) |
Definition at line 363 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| bool Barotrauma.GameSession.IsSubmarineOwned | ( | SubmarineInfo | query | ) |
Definition at line 356 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.KillCharacter | ( | Character | character | ) |
Definition at line 1094 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.LoadPreviousSave | ( | ) |
Definition at line 309 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.LogEndRoundStats | ( | string | eventId, |
| TraitorManager.TraitorResults? | traitorResults = null |
||
| ) |
Definition at line 1013 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.PlaceSubAtStart | ( | Level? | level | ) |
Definition at line 689 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.ReviveCharacter | ( | Character | character | ) |
Definition at line 1105 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.Save | ( | string | filePath | ) |
Definition at line 1180 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.SetRespawnInfo | ( | bool | visible, |
| string | text, | ||
| Color | textColor, | ||
| bool | buttonsVisible, | ||
| bool | waitForNextRoundRespawn | ||
| ) |
Definition at line 231 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.StartRound | ( | LevelData? | levelData, |
| bool | mirrorLevel = false, |
||
| SubmarineInfo? | startOutpost = null, |
||
| SubmarineInfo? | endOutpost = null |
||
| ) |
Definition at line 406 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.StartRound | ( | string | levelSeed, |
| float? | difficulty = null, |
||
| LevelGenerationParams? | levelGenerationParams = null |
||
| ) |
Definition at line 377 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.SwitchSubmarine | ( | SubmarineInfo | newSubmarine, |
| bool | transferItems, | ||
| Client? | client = null |
||
| ) |
Switch to another submarine. The sub is loaded when the next round starts.
Definition at line 318 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| bool Barotrauma.GameSession.ToggleTabMenu | ( | ) |
Definition at line 19 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
| bool Barotrauma.GameSession.TryPurchaseSubmarine | ( | SubmarineInfo | newSubmarine, |
| Client? | client = null |
||
| ) |
Definition at line 340 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| void Barotrauma.GameSession.Update | ( | float | deltaTime | ) |
Definition at line 793 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
static |
Definition at line 177 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
| CrewManager? Barotrauma.GameSession.CrewManager |
Definition at line 32 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| readonly EventManager Barotrauma.GameSession.EventManager |
Definition at line 26 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| GameMode? Barotrauma.GameSession.GameMode |
Definition at line 28 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| List<SubmarineInfo> Barotrauma.GameSession.OwnedSubmarines = new List<SubmarineInfo>() |
Definition at line 106 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| double Barotrauma.GameSession.TimeSpentCleaning |
Definition at line 39 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
| CharacterTeamType? Barotrauma.GameSession.WinningTeam |
Definition at line 48 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 67 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 45 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 90 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 50 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
staticget |
Definition at line 14 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
|
getset |
Definition at line 24 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 54 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 55 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 59 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 57 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 42 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 34 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 52 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 8 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
|
getset |
Definition at line 110 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
get |
Definition at line 76 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
getset |
Definition at line 108 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
getset |
Definition at line 104 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.
|
staticget |
Definition at line 15 of file BarotraumaClient/ClientSource/GameSession/GameSession.cs.
|
get |
Definition at line 112 of file BarotraumaShared/SharedSource/GameSession/GameSession.cs.