Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    VirtualButton.GamePad Class

    Namespace: Stride.Input
    Assembly: Stride.Input.dll

    GamePad virtual button.

    System.Object → VirtualButton → VirtualButton.GamePad
    Derived from VirtualButton.GamePad:

    public class GamePad : VirtualButton, IVirtualButton
    Name Description
    Constructors
    GamePad(String, Int32, Int32, Boolean)
    Fields
    A

    Equivalent to A.

    B

    Equivalent to B.

    Back

    Equivalent to Back.

    LeftShoulder

    Equivalent to LeftShoulder.

    LeftThumb

    Equivalent to LeftThumb.

    LeftThumbAxisX

    Equivalent to the X Axis of LeftThumb.

    LeftThumbAxisY

    Equivalent to the Y Axis of LeftThumb.

    LeftTrigger

    Equivalent to LeftTrigger.

    PadDown

    Equivalent to PadDown.

    PadIndex

    The pad index.

    PadLeft

    Equivalent to PadLeft.

    PadRight

    Equivalent to PadRight.

    PadUp

    Equivalent to PadUp.

    RightShoulder

    Equivalent to RightShoulder.

    RightThumb

    Equivalent to RightThumb.

    RightThumbAxisX

    Equivalent to the X Axis of RightThumb.

    RightThumbAxisY

    Equivalent to the Y Axis of RightThumb.

    RightTrigger

    Equivalent to RightTrigger.

    Start

    Equivalent to Start.

    X

    Equivalent to X.

    Y

    Equivalent to Y.

    Methods
    BuildButtonName()
    GetValue(InputManager)
    IsDown(InputManager)
    IsPressed(InputManager)
    IsReleased(InputManager)
    OfGamePad(Int32)

    Return an instance of a particular GamePad.

    | Improve this Doc View Source

    Constructors


    GamePad(String, Int32, Int32, Boolean)

    protected GamePad(string name, int id, int padIndex, bool isPositiveAndNegative)
    Parameters
    Type Name Description
    System.String name
    System.Int32 id
    System.Int32 padIndex
    System.Boolean isPositiveAndNegative
    | Improve this Doc View Source

    Fields


    A

    Equivalent to A.

    public static readonly VirtualButton.GamePad A
    Field Value
    Type Description
    VirtualButton.GamePad

    B

    Equivalent to B.

    public static readonly VirtualButton.GamePad B
    Field Value
    Type Description
    VirtualButton.GamePad

    Back

    Equivalent to Back.

    public static readonly VirtualButton.GamePad Back
    Field Value
    Type Description
    VirtualButton.GamePad

    LeftShoulder

    Equivalent to LeftShoulder.

    public static readonly VirtualButton.GamePad LeftShoulder
    Field Value
    Type Description
    VirtualButton.GamePad

    LeftThumb

    Equivalent to LeftThumb.

    public static readonly VirtualButton.GamePad LeftThumb
    Field Value
    Type Description
    VirtualButton.GamePad

    LeftThumbAxisX

    Equivalent to the X Axis of LeftThumb.

    public static readonly VirtualButton.GamePad LeftThumbAxisX
    Field Value
    Type Description
    VirtualButton.GamePad

    LeftThumbAxisY

    Equivalent to the Y Axis of LeftThumb.

    public static readonly VirtualButton.GamePad LeftThumbAxisY
    Field Value
    Type Description
    VirtualButton.GamePad

    LeftTrigger

    Equivalent to LeftTrigger.

    public static readonly VirtualButton.GamePad LeftTrigger
    Field Value
    Type Description
    VirtualButton.GamePad

    PadDown

    Equivalent to PadDown.

    public static readonly VirtualButton.GamePad PadDown
    Field Value
    Type Description
    VirtualButton.GamePad

    PadIndex

    The pad index.

    public readonly int PadIndex
    Field Value
    Type Description
    System.Int32

    PadLeft

    Equivalent to PadLeft.

    public static readonly VirtualButton.GamePad PadLeft
    Field Value
    Type Description
    VirtualButton.GamePad

    PadRight

    Equivalent to PadRight.

    public static readonly VirtualButton.GamePad PadRight
    Field Value
    Type Description
    VirtualButton.GamePad

    PadUp

    Equivalent to PadUp.

    public static readonly VirtualButton.GamePad PadUp
    Field Value
    Type Description
    VirtualButton.GamePad

    RightShoulder

    Equivalent to RightShoulder.

    public static readonly VirtualButton.GamePad RightShoulder
    Field Value
    Type Description
    VirtualButton.GamePad

    RightThumb

    Equivalent to RightThumb.

    public static readonly VirtualButton.GamePad RightThumb
    Field Value
    Type Description
    VirtualButton.GamePad

    RightThumbAxisX

    Equivalent to the X Axis of RightThumb.

    public static readonly VirtualButton.GamePad RightThumbAxisX
    Field Value
    Type Description
    VirtualButton.GamePad

    RightThumbAxisY

    Equivalent to the Y Axis of RightThumb.

    public static readonly VirtualButton.GamePad RightThumbAxisY
    Field Value
    Type Description
    VirtualButton.GamePad

    RightTrigger

    Equivalent to RightTrigger.

    public static readonly VirtualButton.GamePad RightTrigger
    Field Value
    Type Description
    VirtualButton.GamePad

    Start

    Equivalent to Start.

    public static readonly VirtualButton.GamePad Start
    Field Value
    Type Description
    VirtualButton.GamePad

    X

    Equivalent to X.

    public static readonly VirtualButton.GamePad X
    Field Value
    Type Description
    VirtualButton.GamePad

    Y

    Equivalent to Y.

    public static readonly VirtualButton.GamePad Y
    Field Value
    Type Description
    VirtualButton.GamePad
    | Improve this Doc View Source

    Methods


    BuildButtonName()

    protected override string BuildButtonName()
    Returns
    Type Description
    System.String
    Overrides
    VirtualButton.BuildButtonName()

    GetValue(InputManager)

    public override float GetValue(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Single
    Overrides
    VirtualButton.GetValue(InputManager)

    IsDown(InputManager)

    public override bool IsDown(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualButton.IsDown(InputManager)

    IsPressed(InputManager)

    public override bool IsPressed(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualButton.IsPressed(InputManager)

    IsReleased(InputManager)

    public override bool IsReleased(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualButton.IsReleased(InputManager)

    OfGamePad(Int32)

    Return an instance of a particular GamePad.

    public VirtualButton.GamePad OfGamePad(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The gamepad index.

    Returns
    Type Description
    VirtualButton.GamePad

    A new GamePad button linked to the gamepad index.


    Inherited Members

    VirtualButton.Id
    VirtualButton.Name
    VirtualButton.ShortName
    VirtualButton.Type
    VirtualButton.IsPositiveAndNegative
    VirtualButton.Index
    VirtualButton.ToString()
    VirtualButton.Registered
    VirtualButton.Find(String)
    VirtualButton.Find(Int32)

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation