Interface IViewModeCollectionConfig

Represents a configuration that provides a collection of available view mode configuration items

Namespace: Fwt.HexTerrains.ViewModes.Data
Assembly: fwt.hexterrains.dll
Syntax
public interface IViewModeCollectionConfig

Properties

ViewModes

Contains the collection of available view mode configuration assets for this component.

Declaration
IEnumerable<IViewModeConfig> ViewModes { get; }
Property Value
Type Description
IEnumerable<IViewModeConfig>

Methods

GetViewMode(string)

Retrieves the index of the specified view mode by its name.

Declaration
int GetViewMode(string viewModeName)
Parameters
Type Name Description
string viewModeName

The name of the view mode to locate. This parameter cannot be null or empty.
Returns
Type Description
int

The zero-based index of the view mode if found; otherwise, -1.
Remarks

If the view mode configuration is not cached, the method updates the cache before searching. The comparison of the view mode name is case-sensitive.

GetViewModeConfig(int)

Retrieves the configuration settings for the specified view mode (by ViewMode index).

Declaration
IViewModeConfig GetViewModeConfig(int viewModeIndex)
Parameters
Type Name Description
int viewModeIndex

The zero-based index of the view mode for which to obtain configuration settings. Must be within the range of available view modes.
Returns
Type Description
IViewModeConfig

An object that provides configuration details for the specified view mode.

GetViewModeConfig(string)

Retrieves the configuration settings for the specified view mode (by ViewMode name set in config).

Declaration
IViewModeConfig GetViewModeConfig(string viewModeName)
Parameters
Type Name Description
string viewModeName

The name of the view mode for which to retrieve the configuration.
Returns
Type Description
IViewModeConfig

An instance of IViewModeConfig containing the configuration settings for the specified view mode, or null if the view mode is not found.
Remarks

Ensure that the specified view mode name corresponds to an existing view mode configuration.

GetViewModeConfig(string, out int)

Retrieves the configuration settings for the specified view mode (by ViewMode name set in config). out parameter viewMode is the index of the view mode with the specified name.

Declaration
IViewModeConfig GetViewModeConfig(string viewModeName, out int viewMode)
Parameters
Type Name Description
string viewModeName

The name of the view mode for which to retrieve the configuration.
int viewMode
Returns
Type Description
IViewModeConfig

An instance of IViewModeConfig containing the configuration settings for the specified view mode, or null if the view mode is not found.
Remarks

Ensure that the specified view mode name corresponds to an existing view mode configuration.

Extension Methods