Class VirtualButtonConfigSet

Namespace

Stride.Input

Assembly

Stride.Input.dll

A collection of VirtualButtonConfig.

public class VirtualButtonConfigSet : Collection<VirtualButtonConfig>, IList<VirtualButtonConfig>, ICollection<VirtualButtonConfig>, IReadOnlyList<VirtualButtonConfig>, IReadOnlyCollection<VirtualButtonConfig>, IEnumerable<VirtualButtonConfig>, IList, ICollection, IEnumerable

Inheritance

object

Collection<VirtualButtonConfig>

VirtualButtonConfigSet

Implements

IList<VirtualButtonConfig>

ICollection<VirtualButtonConfig>

IReadOnlyList<VirtualButtonConfig>

IReadOnlyCollection<VirtualButtonConfig>

IEnumerable<VirtualButtonConfig>

IList

ICollection

IEnumerable

Inherited Members

Collection<VirtualButtonConfig>.Add(VirtualButtonConfig)

Collection<VirtualButtonConfig>.Clear()

Collection<VirtualButtonConfig>.ClearItems()

Collection<VirtualButtonConfig>.Contains(VirtualButtonConfig)

Collection<VirtualButtonConfig>.CopyTo(VirtualButtonConfig[], int)

Collection<VirtualButtonConfig>.GetEnumerator()

Collection<VirtualButtonConfig>.IndexOf(VirtualButtonConfig)

Collection<VirtualButtonConfig>.Insert(int, VirtualButtonConfig)

Collection<VirtualButtonConfig>.InsertItem(int, VirtualButtonConfig)

Collection<VirtualButtonConfig>.Remove(VirtualButtonConfig)

Collection<VirtualButtonConfig>.RemoveAt(int)

Collection<VirtualButtonConfig>.RemoveItem(int)

Collection<VirtualButtonConfig>.SetItem(int, VirtualButtonConfig)

Collection<VirtualButtonConfig>.Count

Collection<VirtualButtonConfig>.this[int]

Collection<VirtualButtonConfig>.Items

Extension Methods

ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>)

EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>)

EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.NotNull<T>(IEnumerable<T>)

EnumerableExtensions.ToHashCode<T>(IEnumerable<T>)

CollectionExtensions.GetItemOrNull<T>(IList<T>, int)

CollectionExtensions.SwapRemoveAt<T>(IList<T>, int)

CollectionExtensions.SwapRemove<T>(IList<T>, T)

CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T)

EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>)

EnumerableExtensions.IsNullOrEmpty(IEnumerable)

Remarks

Several virtual button configurations can be stored in this instance. For example, User0 config could be stored on index 0, User1 on index 1...etc.

Constructors

VirtualButtonConfigSet()

Initializes a new instance of the VirtualButtonConfigSet class.

public VirtualButtonConfigSet()

Methods

GetValue(InputManager, int, object)

Gets a binding value for the specified name and the specified config extract from the VirtualButtonConfigSet.

public virtual float GetValue(InputManager inputManager, int configIndex, object name)

Parameters

inputManager InputManager

The InputManager to used to get the device input.

configIndex int

An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.

name object

Name of the binding.

Returns

float

The value of the binding.

IsDown(InputManager, int, object)

Determines whether the specified binding in the specified config in the VirtualButtonConfigSet is currently pressed down.

public virtual bool IsDown(InputManager inputManager, int configIndex, object name)

Parameters

inputManager InputManager

The InputManager to used to get device input.

configIndex int

An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.

name object

Name of the binding.

Returns

bool

true if the binding is currently pressed down; otherwise, false.

IsPressed(InputManager, int, object)

Determines whether the specified binding in the specified config in the VirtualButtonConfigSet was pressed since the previous Update.

public virtual bool IsPressed(InputManager inputManager, int configIndex, object name)

Parameters

inputManager InputManager

The InputManager to used to get device input.

configIndex int

An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.

name object

Name of the binding.

Returns

bool

true if the binding was pressed; otherwise, false.

IsReleased(InputManager, int, object)

Determines whether the specified binding in the specified config in the VirtualButtonConfigSet was released since the previous Update.

public virtual bool IsReleased(InputManager inputManager, int configIndex, object name)

Parameters

inputManager InputManager

The InputManager to used to get device input.

configIndex int

An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.

name object

Name of the binding.

Returns

bool

true if the binding was released; otherwise, false.