Class VirtualButton.Mouse

Namespace

Stride.Input

Assembly

Stride.Input.dll

Mouse virtual button.

public class VirtualButton.Mouse : VirtualButton, IVirtualButton

Inheritance

object

VirtualButton

VirtualButton.Mouse

Implements

IVirtualButton

Inherited Members

VirtualButton.Id

VirtualButton.Name

VirtualButton.ShortName

VirtualButton.Type

VirtualButton.IsPositiveAndNegative

VirtualButton.Index

VirtualButton.ToString()

VirtualButton.Registered

VirtualButton.Find(string)

VirtualButton.Find(int)

VirtualButton.BuildButtonName()

Constructors

Mouse(string, int, bool)

protected Mouse(string name, int id, bool isPositiveAndNegative)

Parameters

name string

id int

isPositiveAndNegative bool

Fields

DeltaX

Equivalent to X Axis delta of MousePosition.

public static readonly VirtualButton.Mouse DeltaX

Field Value

VirtualButton.Mouse

DeltaY

Equivalent to Y Axis delta of MousePosition.

public static readonly VirtualButton.Mouse DeltaY

Field Value

VirtualButton.Mouse

Extended1

Equivalent to Extended1.

public static readonly VirtualButton.Mouse Extended1

Field Value

VirtualButton.Mouse

Extended2

Equivalent to Extended2.

public static readonly VirtualButton.Mouse Extended2

Field Value

VirtualButton.Mouse

Left

Equivalent to Left.

public static readonly VirtualButton.Mouse Left

Field Value

VirtualButton.Mouse

Middle

Equivalent to Middle.

public static readonly VirtualButton.Mouse Middle

Field Value

VirtualButton.Mouse

PositionX

Equivalent to X Axis of MousePosition.

public static readonly VirtualButton.Mouse PositionX

Field Value

VirtualButton.Mouse

PositionY

Equivalent to Y Axis of MousePosition.

public static readonly VirtualButton.Mouse PositionY

Field Value

VirtualButton.Mouse

Right

Equivalent to Right.

public static readonly VirtualButton.Mouse Right

Field Value

VirtualButton.Mouse

Methods

GetValue(InputManager)

Gets the value associated with this virtual button from an input manager.

public override float GetValue(InputManager manager)

Parameters

manager InputManager

The manager.

Returns

float

System.Single.

IsDown(InputManager)

Indicate if the button is currently down

public override bool IsDown(InputManager manager)

Parameters

manager InputManager

The input manager

Returns

bool

IsPressed(InputManager)

Indicate if the button has been pressed since the last frame

public override bool IsPressed(InputManager manager)

Parameters

manager InputManager

The input manager

Returns

bool

IsReleased(InputManager)

Indicate if the button has been released since the last frame

public override bool IsReleased(InputManager manager)

Parameters

manager InputManager

The input manager

Returns

bool