Class SurferSO

Scriptable object of Surfer that stores the state names

Inheritance

Object

SurferSO

Namespace: Surfer

Assembly: cs.temp.dll.dll

Syntax

public class SurferSO : ScriptableObject

Properties

BuildVersions

Declaration

public VersionsDictionary BuildVersions { get; }

Property Value

Type	Description
VersionsDictionary

DoubleClickDelay

Declaration

public float DoubleClickDelay { get; set; }

Property Value

Type	Description
Single

InputIcons

Declaration

public SUInputIconsDict InputIcons { get; }

Property Value

Type	Description
SUInputIconsDict

Layers

Declaration

public string[] Layers { get; }

Property Value

Type	Description
String[]

SelectedThemeGUID

Declaration

public string SelectedThemeGUID { get; set; }

Property Value

Type	Description
String

Tags

Declaration

public string[] Tags { get; }

Property Value

Type	Description
String[]

Themes

Declaration

public ThemesDictionary Themes { get; }

Property Value

Type	Description
ThemesDictionary

Methods

AddEvent(String)

Add a new custom event.

Declaration

public void AddEvent(string newName)

Parameters

Type	Name	Description
String	newName	new event name

AddInputIconsPlatform(SUPlatform_ID, Action, Action)

Add a new input icons platform.

Declaration

public void AddInputIconsPlatform(SUPlatform_ID platform, Action OnFail, Action OnSuccess)

Parameters

Type	Name	Description
SUPlatform_ID	platform
Action	OnFail
Action	OnSuccess

AddState(String)

Add a new state.

Declaration

public void AddState(string newName)

Parameters

Type	Name	Description
String	newName	new state name

AddTheme(String, Action, Action<String>)

Add a new theme.

Declaration

public void AddTheme(string newName, Action OnFail, Action<string> OnSuccess)

Parameters

Type	Name	Description
String	newName	new theme name
Action	OnFail
Action<String>	OnSuccess

GetEvent(String)

Get the name of the event with the specific key.

Declaration

public string GetEvent(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
String	event name

GetEventKey(String)

Get the key of a specific event.

Declaration

public string GetEventKey(string eventName)

Parameters

Type	Name	Description
String	eventName	event name

Returns

Type	Description
String	key of the event

GetEventsList(Boolean)

Get a list of all the event names.

Declaration

public string[] GetEventsList(bool addConstPrefix = false)

Parameters

Type	Name	Description
Boolean	addConstPrefix

Returns

Type	Description
String[]	names list

GetInputIcons(SUPlatform_ID)

Get the input icons data with the specific key.

Declaration

public SUInputIconsData GetInputIcons(SUPlatform_ID platformID)

Parameters

Type	Name	Description
SUPlatform_ID	platformID

Returns

Type	Description
SUInputIconsData	platform name

GetInputIconsPlatformNames()

Declaration

public string[] GetInputIconsPlatformNames()

Returns

Type	Description
String[]

GetSceneGUID(String)

Get a GUID of a scene

Declaration

public string GetSceneGUID(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
String	scene guid

GetSceneName(String)

Get the name of a scene

Declaration

public string GetSceneName(string guid)

Parameters

Type	Name	Description
String	guid

Returns

Type	Description
String	scene name

GetScenesNameStrings(Boolean)

Get all scene names

Declaration

public string[] GetScenesNameStrings(bool addConstPrefix = false)

Parameters

Type	Name	Description
Boolean	addConstPrefix

Returns

Type	Description
String[]	array of scene names

GetState(String)

Get the name of the state with the specific key.

Declaration

public string GetState(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
String	state name

GetStateKey(String)

Get the key of a specific state.

Declaration

public string GetStateKey(string stateName)

Parameters

Type	Name	Description
String	stateName	state name

Returns

Type	Description
String	key of the state

GetStatesList()

Get a list of all the state names.

Declaration

public string[] GetStatesList()

Returns

Type	Description
String[]	names list

GetTheme(String)

Get the theme data with the specific key.

Declaration

public SUThemeData GetTheme(string key)

Parameters

Type	Name	Description
String	key	theme key

Returns

Type	Description
SUThemeData	theme name

GetThemeKey(String)

Get the key of a specific theme.

Declaration

public string GetThemeKey(string name)

Parameters

Type	Name	Description
String	name	theme name

Returns

Type	Description
String	key of the theme

GetThemeName(String)

Get the name of a specific theme.

Declaration

public string GetThemeName(string guid)

Parameters

Type	Name	Description
String	guid	theme guid

Returns

Type	Description
String	name of the theme

RemoveEvent(String)

Remove a specific event.

Declaration

public void RemoveEvent(string eventName)

Parameters

Type	Name	Description
String	eventName	event name

RemoveInputIconsPlatform(SUPlatform_ID)

Remove a specific input icons platform.

Declaration

public void RemoveInputIconsPlatform(SUPlatform_ID platID)

Parameters

Type	Name	Description
SUPlatform_ID	platID

RemoveState(String)

Remove a specific state.

Declaration

public void RemoveState(string stateName)

Parameters

Type	Name	Description
String	stateName	state name

RemoveTheme(String)

Remove a specific theme.

Declaration

public void RemoveTheme(string name)

Parameters

Type	Name	Description
String	name

RenameEvent(String, String)

Rename a specific event. Used only in the Surfer Settings Window

Declaration

public void RenameEvent(string key, string newName)

Parameters

Type	Name	Description
String	key
String	newName	event new name

RenameState(String, String)

Rename a specific state. Used only in the Surfer Settings Window

Declaration

public void RenameState(string key, string newName)

Parameters

Type	Name	Description
String	key
String	newName	state new name

RenameTheme(String, String, Action, Action)

Rename a specific theme. Used only in the Surfer Settings Window

Declaration

public void RenameTheme(string key, string newName, Action OnFail, Action OnSuccess)

Parameters

Type	Name	Description
String	key
String	newName	theme new name
Action	OnFail
Action	OnSuccess

SetUp()

Adds the default state names.Used when it is first created

Declaration

public void SetUp()