Table of Contents

Class Options

Namespace
Global
Assembly
Assembly-CSharp.dll
public class Options
Inheritance
Options
Inherited Members

Constructors

Options(RainWorld) 

public Options(RainWorld rainWorld)

Parameters

rainWorld RainWorld

Fields

OLD_PS4_OPTIONS_KEY 

public const string OLD_PS4_OPTIONS_KEY = "rw_options"

Field Value

string

OLD_PS4_SAVE_FILE_DEFINITION 

public static readonly UserData.FileDefinition OLD_PS4_SAVE_FILE_DEFINITION

Field Value

UserData.FileDefinition

OLD_PS4_SAVE_KEY 

public const string OLD_PS4_SAVE_KEY = "rw_savedata"

Field Value

string

OPTIONS_FILE_DEFINITION 

public static readonly UserData.FileDefinition OPTIONS_FILE_DEFINITION

Field Value

UserData.FileDefinition

OPTIONS_KEY 

public const string OPTIONS_KEY = "options"

Field Value

string

PLAYER_COUNT 

public const int PLAYER_COUNT = 4

Field Value

int

SWITCH_MOUNT_NAME 

public const string SWITCH_MOUNT_NAME = "rainworld"

Field Value

string

SafeScreenOffset 

public readonly Vector2 SafeScreenOffset

Field Value

Vector2

_enterButton 

public RainWorldPlugin.EnterButton _enterButton

Field Value

RainWorldPlugin.EnterButton

_enterButtonSet 

public bool _enterButtonSet

Field Value

bool

allGamePads 

public bool allGamePads

Field Value

bool

analogSensitivity 

public float analogSensitivity

Field Value

float

arenaMusicVolume 

public float arenaMusicVolume

Field Value

float

arenaSittingLocalData 

public string arenaSittingLocalData

Field Value

string

aspectRatioStrings 

public static string[] aspectRatioStrings

Field Value

string[]

cameraCycling 

public bool cameraCycling

Field Value

bool

commentary 

public bool commentary

Field Value

bool

controls 

public Options.ControlSetup[] controls

Field Value

ControlSetup[]

createdNewThisLaunch 

public bool createdNewThisLaunch

Field Value

bool

dlcTutorialShown 

public bool dlcTutorialShown

Field Value

bool

enabledMods 

public List<string> enabledMods

Field Value

List<string>

foundOldOptionsFile 

public bool foundOldOptionsFile

Field Value

bool

fpsCap 

public int fpsCap

Field Value

int

friendlyFire 

public bool friendlyFire

Field Value

bool

friendlyLizards 

public bool friendlyLizards

Field Value

bool

friendlySteal 

public bool friendlySteal

Field Value

bool

isOnSteamDeck 

public static bool isOnSteamDeck

Field Value

bool

jollyCameraInputSpeed 

public Options.JollyCameraInputSpeed jollyCameraInputSpeed

Field Value

Options.JollyCameraInputSpeed

jollyColorMode 

public Options.JollyColorMode jollyColorMode

Field Value

Options.JollyColorMode

jollyDifficulty 

public Options.JollyDifficulty jollyDifficulty

Field Value

Options.JollyDifficulty

jollyHud 

public bool jollyHud

Field Value

bool

jollyPlayerOptionsArray 

public JollyPlayerOptions[] jollyPlayerOptionsArray

Field Value

JollyPlayerOptions[]

language 

public InGameTranslator.LanguageID language

Field Value

InGameTranslator.LanguageID

lastGameVersion 

public string lastGameVersion

Field Value

string

modChecksums 

public Dictionary<string, string> modChecksums

Field Value

Dictionary<string, string>

modLoadOrder 

public Dictionary<string, int> modLoadOrder

Field Value

Dictionary<string, int>

musicVolume 

public float musicVolume

Field Value

float

oldPS4FileData 

public Dictionary<string, string> oldPS4FileData

Field Value

Dictionary<string, string>

oldPS4FileLoaded 

public bool oldPS4FileLoaded

Field Value

bool

oldPS4FileSettings 

public Dictionary<string, string> oldPS4FileSettings

Field Value

Dictionary<string, string>

oldPS4SaveFile 

public UserData.File oldPS4SaveFile

Field Value

UserData.File

optionsFile 

public UserData.File optionsFile

Field Value

UserData.File

optionsFileCanSave 

public bool optionsFileCanSave

Field Value

bool

playerToSetInputFor 

public int playerToSetInputFor

Field Value

int

quality 

public Options.Quality quality

Field Value

Options.Quality

rainWorld 

public RainWorld rainWorld

Field Value

RainWorld

remixTutorialShown 

public bool remixTutorialShown

Field Value

bool

resolution 

public int resolution

Field Value

int

sandboxRoomLocalData 

public Dictionary<string, string> sandboxRoomLocalData

Field Value

Dictionary<string, string>

saveSlot 

public int saveSlot

Field Value

int

screenResolutions 

public static Vector2[] screenResolutions

Field Value

Vector2[]

smartShortcuts 

public bool smartShortcuts

Field Value

bool

soundEffectsVolume 

public float soundEffectsVolume

Field Value

float

subBackground 

public MenuScene.SceneID subBackground

Field Value

MenuScene.SceneID

templatePlayer 

public static Player templatePlayer

Field Value

Player

timeSinceLastSaveCopy 

public int timeSinceLastSaveCopy

Field Value

int

titleBackground 

public MenuScene.SceneID titleBackground

Field Value

MenuScene.SceneID

unrecognizedNonSyncedSaveStrings 

public List<string> unrecognizedNonSyncedSaveStrings

Field Value

List<string>

unrecognizedSaveStrings 

public List<string> unrecognizedSaveStrings

Field Value

List<string>

validation 

public bool validation

Field Value

bool

vibration 

public bool vibration

Field Value

bool

vsync 

public bool vsync

Field Value

bool

windowed 

public bool windowed

Field Value

bool

Properties

JollyPlayerCount 

public int JollyPlayerCount { get; }

Property Value

int

SaveFileName 

public string SaveFileName { get; }

Property Value

string

ScreenSize 

public Vector2 ScreenSize { get; }

Property Value

Vector2

SubBackground 

public MenuScene.SceneID SubBackground { get; }

Property Value

MenuScene.SceneID

TitleBackground 

public MenuScene.SceneID TitleBackground { get; }

Property Value

MenuScene.SceneID

enterButton 

public RainWorldPlugin.EnterButton enterButton { get; }

Property Value

RainWorldPlugin.EnterButton

fullScreen 

public bool fullScreen { get; }

Property Value

bool

optionsLoaded 

public bool optionsLoaded { get; set; }

Property Value

bool

Methods

ApplyOption(string[]) 

public bool ApplyOption(string[] splt2)

Parameters

splt2 string[]

Returns

bool

CheckLoadOldPS4SaveFile() 

public bool CheckLoadOldPS4SaveFile()

Returns

bool

ContainsArenaSitting() 

public bool ContainsArenaSitting()

Returns

bool

DeleteArenaSitting() 

public void DeleteArenaSitting()

DeveloperCommentaryLocalized() 

public bool DeveloperCommentaryLocalized()

Returns

bool

FromString(string) 

public void FromString(string s)

Parameters

s string

FromUnsyncedString(string) 

public void FromUnsyncedString(string s)

Parameters

s string

GetOldPS4ProgressionSave() 

public string GetOldPS4ProgressionSave()

Returns

string

Load() 

public void Load()

LoadArenaSetup(string) 

public string LoadArenaSetup(string arenaSetupFallbackFile)

Parameters

arenaSetupFallbackFile string

Returns

string

LoadArenaSitting() 

public string LoadArenaSitting()

Returns

string

LoadControllerOptions() 

public void LoadControllerOptions()

LoadOldPS4OptionsFile() 

public void LoadOldPS4OptionsFile()

LoadOptions() 

public void LoadOptions()

LoadOptionsFallback() 

public void LoadOptionsFallback()

LoadSandbox(string, string) 

public string LoadSandbox(string room, string sandboxRoomFallbackFile)

Parameters

room string
sandboxRoomFallbackFile string

Returns

string

OldPS4SaveFile_OnReadCompleted(File, Result) 

public void OldPS4SaveFile_OnReadCompleted(UserData.File file, UserData.Result result)

Parameters

file UserData.File
result UserData.Result

OnLoadFinished() 

public void OnLoadFinished()

OptionsFile_OnDeleteCompleted(File, Result) 

public void OptionsFile_OnDeleteCompleted(UserData.File file, UserData.Result result)

Parameters

file UserData.File
result UserData.Result

OptionsFile_OnReadCompleted(File, Result) 

public void OptionsFile_OnReadCompleted(UserData.File file, UserData.Result result)

Parameters

file UserData.File
result UserData.Result

OptionsFile_OnWriteCompleted_NewFile(File, Result) 

public void OptionsFile_OnWriteCompleted_NewFile(UserData.File file, UserData.Result result)

Parameters

file UserData.File
result UserData.Result

Options_OnOldPS4SaveLoaded(bool) 

public void Options_OnOldPS4SaveLoaded(bool success)

Parameters

success bool

Platform_OnRequestUserDataRead(List<object>) 

public void Platform_OnRequestUserDataRead(List<object> pendingUserDataReads)

Parameters

pendingUserDataReads List<object>

ReapplyUnrecognized() 

public void ReapplyUnrecognized()

ReassignAllJoysticks() 

public void ReassignAllJoysticks()

Save() 

public void Save()

SaveArenaSetup(string) 

public void SaveArenaSetup(string arenaSetup)

Parameters

arenaSetup string

SaveArenaSitting(string) 

public void SaveArenaSitting(string arenaSitting)

Parameters

arenaSitting string

SaveSandbox(string, string) 

public void SaveSandbox(string room, string sandbox)

Parameters

room string
sandbox string

SetAchievementsFile() 

public void SetAchievementsFile()

ToString() 

public override string ToString()

Returns

string

ToStringNonSynced() 

public string ToStringNonSynced()

Returns

string

UserData_OnFileMounted(File, Result) 

public void UserData_OnFileMounted(UserData.File file, UserData.Result result)

Parameters

file UserData.File
result UserData.Result

UserData_OnOldPS4FileMounted(File, Result) 

public void UserData_OnOldPS4FileMounted(UserData.File file, UserData.Result result)

Parameters

file UserData.File
result UserData.Result

UserInput_AfterControllersConnected(Profile) 

public void UserInput_AfterControllersConnected(Profiles.Profile profile)

Parameters

profile Profiles.Profile

UserInput_OnControllerConnected(Profile, int) 

public void UserInput_OnControllerConnected(Profiles.Profile profile, int controllerId)

Parameters

profile Profiles.Profile
controllerId int

Events

onOldPS4SaveLoaded 

public event Action<bool> onOldPS4SaveLoaded

Event Type

Action<bool>
Edit this page