Interface IInputTemplate

Represents an input configuration template from which valid input configuration can be serialized.

Inherited Members

IConfigurationSection.Descriptor

IConfigurationSection.ValueCollection

IConfigurationSection.Item[String]

System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<Snowflake.Configuration.IConfigurationOptionDescriptor, Snowflake.Configuration.IConfigurationValue>>.GetEnumerator()

System.Collections.IEnumerable.GetEnumerator()

Namespace: Snowflake.Configuration.Input

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IInputTemplate : IConfigurationSection, IEnumerable<KeyValuePair<IConfigurationOptionDescriptor, IConfigurationValue>>, IEnumerable

Properties

Item[ControllerElement]

Gets or sets the real device element that has been mapped to a virtual element.

This will set all matching options for every IInputOption that matches the provided TargetElement and the provided DeviceCapability, depending on the DeviceCapabilityClass of the option.

Declaration

DeviceCapability this[ControllerElement targetElement] { set; }

Parameters

Type	Name	Description
ControllerElement	targetElement	The virtual element on the controller definition

Property Value

Type	Description
DeviceCapability

Options

Gets the options representing the fields in which the options are serialized in configuration, the implementation of this should ensure that this is enumerated in the same order with which the properties are described.

Declaration

IEnumerable<IInputOption> Options { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IInputOption>

PlayerIndex

Gets the controller index of this template instance. This is zero indexed, Player 1 for example is index 0.

Declaration

int PlayerIndex { get; }

Property Value

Type	Description
System.Int32

Values

Gets the mapped controller elements of the input configuration. A proper implementation should require this be immutable. This dictionary is keyed on the property names of the input template interface.

Declaration

IReadOnlyDictionary<string, DeviceCapability> Values { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, DeviceCapability>