Class NeoFpsInputActions

Provides programmatic access to , , and instances defined in asset "Assets/NeoFPS/Extensions/InputSystem/Collections/NeoFpsInputActions.inputactions".

Inheritance

Object

NeoFpsInputActions

Implements

System.IDisposable

Namespace: NeoFPS

Assembly: NeoFPS.dll

Syntax

public class NeoFpsInputActions : IInputActionCollection2, IDisposable

Remarks

This class is source generated and any manual edits will be discarded if the associated asset is reimported or modified.

Examples

using namespace UnityEngine;
using UnityEngine.InputSystem;

// Example of using an InputActionMap named "Player" from a UnityEngine.MonoBehaviour implementing callback interface.
public class Example : MonoBehaviour, MyActions.IPlayerActions
{
    private MyActions_Actions m_Actions;                  // Source code representation of asset.
    private MyActions_Actions.PlayerActions m_Player;     // Source code representation of action map.

    void Awake()
    {
        m_Actions = new MyActions_Actions();              // Create asset object.
        m_Player = m_Actions.Player;                      // Extract action map object.
        m_Player.AddCallbacks(this);                      // Register callback interface IPlayerActions.
    }

    void OnDestroy()
    {
        m_Actions.Dispose();                              // Destroy asset object.
    }

    void OnEnable()
    {
        m_Player.Enable();                                // Enable all actions within map.
    }

    void OnDisable()
    {
        m_Player.Disable();                               // Disable all actions within map.
    }

    #region Interface implementation of MyActions.IPlayerActions

    // Invoked when "Move" action is either started, performed or canceled.
    public void OnMove(InputAction.CallbackContext context)
    {
        Debug.Log($"OnMove: {context.ReadValue<Vector2>()}");
    }

    // Invoked when "Attack" action is either started, performed or canceled.
    public void OnAttack(InputAction.CallbackContext context)
    {
        Debug.Log($"OnAttack: {context.ReadValue<float>()}");
    }

    #endregion
}

Constructors

NeoFpsInputActions()

Constructs a new instance.

Declaration

public NeoFpsInputActions()

Properties

asset

Provides access to the underlying asset instance.

Declaration

public InputActionAsset asset { get; }

Property Value

Type	Description
InputActionAsset

bindingMask

Declaration

public InputBinding? bindingMask { get; set; }

Property Value

Type	Description
System.Nullable<InputBinding>

bindings

Declaration

public IEnumerable<InputBinding> bindings { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<InputBinding>

Combat

Provides a new NeoFpsInputActions.CombatActions instance referencing this action map.

Declaration

public NeoFpsInputActions.CombatActions Combat { get; }

Property Value

Type	Description
NeoFpsInputActions.CombatActions

controlSchemes

Declaration

public ReadOnlyArray<InputControlScheme> controlSchemes { get; }

Property Value

Type	Description
ReadOnlyArray<InputControlScheme>

devices

Declaration

public ReadOnlyArray<InputDevice>? devices { get; set; }

Property Value

Type	Description
System.Nullable<ReadOnlyArray<InputDevice>>

GamepadScheme

Provides access to the input control scheme.

Declaration

public InputControlScheme GamepadScheme { get; }

Property Value

Type	Description
InputControlScheme

Interaction

Provides a new NeoFpsInputActions.InteractionActions instance referencing this action map.

Declaration

public NeoFpsInputActions.InteractionActions Interaction { get; }

Property Value

Type	Description
NeoFpsInputActions.InteractionActions

Inventory

Provides a new NeoFpsInputActions.InventoryActions instance referencing this action map.

Declaration

public NeoFpsInputActions.InventoryActions Inventory { get; }

Property Value

Type	Description
NeoFpsInputActions.InventoryActions

KeyboardAndMouseScheme

Provides access to the input control scheme.

Declaration

public InputControlScheme KeyboardAndMouseScheme { get; }

Property Value

Type	Description
InputControlScheme

Miscellaneous

Provides a new NeoFpsInputActions.MiscellaneousActions instance referencing this action map.

Declaration

public NeoFpsInputActions.MiscellaneousActions Miscellaneous { get; }

Property Value

Type	Description
NeoFpsInputActions.MiscellaneousActions

Movement

Provides a new NeoFpsInputActions.MovementActions instance referencing this action map.

Declaration

public NeoFpsInputActions.MovementActions Movement { get; }

Property Value

Type	Description
NeoFpsInputActions.MovementActions

Methods

Contains(InputAction)

Declaration

public bool Contains(InputAction action)

Parameters

Type	Name	Description
InputAction	action

Returns

Type	Description
System.Boolean

Disable()

Declaration

public void Disable()

Dispose()

Destroys this asset and all associated instances.

Declaration

public void Dispose()

Enable()

Declaration

public void Enable()

Finalize()

Declaration

protected void Finalize()

FindAction(String, Boolean)

Declaration

public InputAction FindAction(string actionNameOrId, bool throwIfNotFound = false)

Parameters

Type	Name	Description
System.String	actionNameOrId
System.Boolean	throwIfNotFound

Returns

Type	Description
InputAction

FindBinding(InputBinding, out InputAction)

Declaration

public int FindBinding(InputBinding bindingMask, out InputAction action)

Parameters

Type	Name	Description
InputBinding	bindingMask
InputAction	action

Returns

Type	Description
System.Int32

GetEnumerator()

Declaration

public IEnumerator<InputAction> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<InputAction>

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.IDisposable