ConfigurableInputCommand Class

Represents an input command that supports a flexible input mapping. (Experimental: This class is experimental and subject to change.)

Inheritance Hierarchy

SystemObject
DigitalRune.Game.InputConfigurableInputCommand

Namespace: DigitalRune.Game.Input
Assembly: DigitalRune.Game.Input (in DigitalRune.Game.Input.dll) Version: 1.8.0.0 (1.8.0.14467)

Syntax

public class ConfigurableInputCommand : IInputCommand, 
	INamedObject

Public Class ConfigurableInputCommand
	Implements IInputCommand, INamedObject

public ref class ConfigurableInputCommand : IInputCommand, 
	INamedObject

type ConfigurableInputCommand =  
    class
        interface IInputCommand
        interface INamedObject
    end

The ConfigurableInputCommand type exposes the following members.

Constructors

	Name	Description
	ConfigurableInputCommand	Initializes a new instance of the ConfigurableInputCommand class.
	ConfigurableInputCommand(String)	Initializes a new instance of the ConfigurableInputCommand class.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Updates internal values of this command. This method is called automatically in each frame by the input service.

Properties

	Name	Description
	Description	Gets or sets the description of this command.
	Enabled	Gets or sets a value indicating whether this ConfigurableInputCommand is enabled. If the command is not enabled, the Value is always 0.
	InputService	Gets or sets the input service.
	LogicalPlayerIndex	Gets or sets the index of the logical player.
	Name	Gets the name.
	PrimaryMapping	Gets or sets the primary input mapping that triggers the command.
	Scale	Gets or sets the scale that is applied to the Value.
	SecondaryMapping	Gets or sets the secondary input mapping that triggers the command. This mapping is not evaluated if the PrimaryMapping has influenced the Value.
	Sensitivity	Gets or sets the sensitivity that is used for analog input.
	Value	Gets the value.

Remarks

This command can be triggered with keys and buttons defined in the PrimaryMapping and SecondaryMapping.