The Definitto system configuration data. Available both in the Play and Editor modes. More...

Inheritance diagram for Turbanov.Toolworks.Definitto.DefinittoSettings:

Collaboration diagram for Turbanov.Toolworks.Definitto.DefinittoSettings:

Public Member Functions
IEnumerable< BuildType >	GetBuildTypes (BuildCategoryId categoryId)
	Gets the build types by category. More...

IEnumerable< BuildTypeId >	GetBuildTypeIds (BuildCategoryId categoryId)
	Gets the available build type identifiers by their category. More...

IEnumerable< Platform >	GetPlatforms (PlatformCategoryId categoryId)
	Gets the available platforms by their category. More...

IEnumerable< PlatformId >	GetPlatformIds (PlatformCategoryId categoryId)
	Gets the available platform identifiers by their category. More...

BuildTypeId	GetBuildTypeIdAt (int index)
	Get the build type id at the specified item index. More...

int	GetBuildTypeIndex (BuildTypeId type)
	Get the index of the build type. More...

Public Attributes
const string	Filename = "Settings.asset"
	The filename of the asset. More...

const string	ResourcePath = DefinittoInfo.CamelTitle + "/Settings"
	The resource path for the system settings object. More...

Static Public Attributes
static DefinittoSettingsEvent	InstanceLoaded = new DefinittoSettingsEvent()
	An event indicating that the system settings instance was successfully and fully loaded. More...

static DefinittoSettingsEvent	InstanceUnloading = new DefinittoSettingsEvent()
	An event indicating that systems settings are being unloaded. More...

Properties
IEnumerable< BuildCategory >	BuildCategories `[get]`
	The definitions of the build categories. More...

IEnumerable< BuildType >	BuildTypes `[get]`
	The definitions of the build types. More...

IEnumerable< PlatformCategory >	PlatformCategories `[get]`
	The definitions of the platform categories. More...

IEnumerable< Platform >	Platforms `[get]`
	The definitions of the platforms. More...

IEnumerable< BuildTypeId >	BuildTypesIds `[get]`
	Gets the available build type identifiers. More...

IEnumerable< PlatformId >	PlatformIds `[get]`
	Gets the available platform types. More...

Defines	BuiltInDefines `[get]`
	Gets the built in defines. More...

bool	IsFullyLoaded `[get]`
	Were the system settings actually fully loaded (deserialized)? More...

static bool	HasInstance `[get]`
	Is there an active fully loaded instance currently? More...

static DefinittoSettings	Instance `[get, set]`
	The instance of the settings singleton. More...

BuildCategory	this[BuildCategoryId id] `[get]`
	Gets the build category by its identifier. More...

BuildType	this[BuildTypeId id] `[get]`
	Get the build type by its identifier. More...

PlatformCategory	this[PlatformCategoryId id] `[get]`
	Gets the platform category by its identifier. More...

Platform	this[PlatformId id] `[get]`
	Get the platform by its identifier. More...

Platform	this[RuntimePlatform runtimePlatform] `[get]`
	Get the system settings for the specified Unity's runtime platform. More...

Detailed Description

The Definitto system configuration data. Available both in the Play and Editor modes.

Member Function Documentation

◆ GetBuildTypeIdAt()

BuildTypeId Turbanov.Toolworks.Definitto.DefinittoSettings.GetBuildTypeIdAt ( int index )

Get the build type id at the specified item index.

Parameters

index The index of the item.

Returns: The build type at a specified index.

◆ GetBuildTypeIds()

IEnumerable<BuildTypeId> Turbanov.Toolworks.Definitto.DefinittoSettings.GetBuildTypeIds ( BuildCategoryId categoryId )

Gets the available build type identifiers by their category.

Parameters

categoryId The build category identifier.

Returns: The build type identifiers.

◆ GetBuildTypeIndex()

int Turbanov.Toolworks.Definitto.DefinittoSettings.GetBuildTypeIndex ( BuildTypeId type )

Get the index of the build type.

Parameters

type	The build type to get the index for.

Returns: The index of the build type.

◆ GetBuildTypes()

IEnumerable<BuildType> Turbanov.Toolworks.Definitto.DefinittoSettings.GetBuildTypes ( BuildCategoryId categoryId )

Gets the build types by category.

Returns: The platforms.

Parameters

categoryId The category identifier.

◆ GetPlatformIds()

IEnumerable<PlatformId> Turbanov.Toolworks.Definitto.DefinittoSettings.GetPlatformIds ( PlatformCategoryId categoryId )

Gets the available platform identifiers by their category.

Parameters

categoryId The platform category identifier.

Returns: The platform identifiers.

◆ GetPlatforms()

IEnumerable<Platform> Turbanov.Toolworks.Definitto.DefinittoSettings.GetPlatforms ( PlatformCategoryId categoryId )

Gets the available platforms by their category.

Parameters

categoryId The category identifier.

Returns: The platforms.

Member Data Documentation

◆ Filename

const string Turbanov.Toolworks.Definitto.DefinittoSettings.Filename = "Settings.asset"

The filename of the asset.

◆ InstanceLoaded

DefinittoSettingsEvent Turbanov.Toolworks.Definitto.DefinittoSettings.InstanceLoaded = new DefinittoSettingsEvent()

static

An event indicating that the system settings instance was successfully and fully loaded.

◆ InstanceUnloading

DefinittoSettingsEvent Turbanov.Toolworks.Definitto.DefinittoSettings.InstanceUnloading = new DefinittoSettingsEvent()

static

An event indicating that systems settings are being unloaded.

◆ ResourcePath

const string Turbanov.Toolworks.Definitto.DefinittoSettings.ResourcePath = DefinittoInfo.CamelTitle + "/Settings"

The resource path for the system settings object.

Property Documentation

◆ BuildCategories

IEnumerable<BuildCategory> Turbanov.Toolworks.Definitto.DefinittoSettings.BuildCategories

get

The definitions of the build categories.

◆ BuildTypes

IEnumerable<BuildType> Turbanov.Toolworks.Definitto.DefinittoSettings.BuildTypes

get

The definitions of the build types.

◆ BuildTypesIds

IEnumerable<BuildTypeId> Turbanov.Toolworks.Definitto.DefinittoSettings.BuildTypesIds

get

Gets the available build type identifiers.

The available build type identifiers.

◆ BuiltInDefines

Defines Turbanov.Toolworks.Definitto.DefinittoSettings.BuiltInDefines

get

Gets the built in defines.

The built in defines.

◆ HasInstance

bool Turbanov.Toolworks.Definitto.DefinittoSettings.HasInstance

staticget

Is there an active fully loaded instance currently?

◆ Instance

DefinittoSettings Turbanov.Toolworks.Definitto.DefinittoSettings.Instance

staticgetset

The instance of the settings singleton.

◆ IsFullyLoaded

bool Turbanov.Toolworks.Definitto.DefinittoSettings.IsFullyLoaded

get

Were the system settings actually fully loaded (deserialized)?

true if this instance is fully loaded; otherwise, false.

◆ PlatformCategories

IEnumerable<PlatformCategory> Turbanov.Toolworks.Definitto.DefinittoSettings.PlatformCategories

get

The definitions of the platform categories.

◆ PlatformIds

IEnumerable<PlatformId> Turbanov.Toolworks.Definitto.DefinittoSettings.PlatformIds

get

Gets the available platform types.

The available platform types.

◆ Platforms

IEnumerable<Platform> Turbanov.Toolworks.Definitto.DefinittoSettings.Platforms

get

The definitions of the platforms.

◆ this[BuildCategoryId id]

BuildCategory Turbanov.Toolworks.Definitto.DefinittoSettings.this[BuildCategoryId id]

get

Gets the build category by its identifier.

Parameters

id	The build category identifier.

◆ this[BuildTypeId id]

BuildType Turbanov.Toolworks.Definitto.DefinittoSettings.this[BuildTypeId id]

get

Get the build type by its identifier.

Parameters

id	The build type to get the settings for.

Returns: The settings for the build type.

◆ this[PlatformCategoryId id]

PlatformCategory Turbanov.Toolworks.Definitto.DefinittoSettings.this[PlatformCategoryId id]

get

Gets the platform category by its identifier.

Parameters

id	The platform category identifier.

◆ this[PlatformId id]

Platform Turbanov.Toolworks.Definitto.DefinittoSettings.this[PlatformId id]

get

Get the platform by its identifier.

Parameters

platform The platform to get settings for.

Returns: The system settings for the platform or
null
, if no settings for that platform are available.

◆ this[RuntimePlatform runtimePlatform]

Platform Turbanov.Toolworks.Definitto.DefinittoSettings.this[RuntimePlatform runtimePlatform]

get

Get the system settings for the specified Unity's runtime platform.

Parameters

runtimePlatform The Unity runtime platform to get settings for.

Returns: The system settings for the runtime platform or
null
, if no settings for that runtime platform are available.

The documentation for this class was generated from the following file:

P:/projects.local/iptvd/toolworks/definitto/definitto/Definitto.Unity/Assets/Definitto/Scripts/DefinittoSettings.cs

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ GetBuildTypeIdAt()

◆ GetBuildTypeIds()

◆ GetBuildTypeIndex()

◆ GetBuildTypes()

◆ GetPlatformIds()

◆ GetPlatforms()

Member Data Documentation

◆ Filename

◆ InstanceLoaded

◆ InstanceUnloading

◆ ResourcePath

Property Documentation

◆ BuildCategories

◆ BuildTypes

◆ BuildTypesIds

◆ BuiltInDefines

◆ HasInstance

◆ Instance

◆ IsFullyLoaded

◆ PlatformCategories

◆ PlatformIds

◆ Platforms

◆ this[BuildCategoryId id]

◆ this[BuildTypeId id]

◆ this[PlatformCategoryId id]

◆ this[PlatformId id]

◆ this[RuntimePlatform runtimePlatform]