Class VirtualButtonConfigSet
A collection of VirtualButtonConfig.
public class VirtualButtonConfigSet : Collection<VirtualButtonConfig>, IList<VirtualButtonConfig>, ICollection<VirtualButtonConfig>, IReadOnlyList<VirtualButtonConfig>, IReadOnlyCollection<VirtualButtonConfig>, IEnumerable<VirtualButtonConfig>, IList, ICollection, IEnumerable
- Inheritance
-
VirtualButtonConfigSet
- Implements
- Inherited Members
- Extension Methods
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
InputManagerThe InputManager to used to get the device input.
configIndex
intAn index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.
name
objectName 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
InputManagerThe InputManager to used to get device input.
configIndex
intAn index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.
name
objectName 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
InputManagerThe InputManager to used to get device input.
configIndex
intAn index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.
name
objectName 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
InputManagerThe InputManager to used to get device input.
configIndex
intAn index to a VirtualButtonConfig stored in the VirtualButtonConfigSet.
name
objectName of the binding.
Returns
- bool
true
if the binding was released; otherwise,false
.