CityBuilderCore.CityInputActions Class Reference

Detailed Description

Provides programmatic access to InputActionAsset, InputActionMap, InputAction and InputControlScheme instances defined in asset "Assets/SoftLeitner/CityBuilderCore/Settings/CityInputActions.inputactions".

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

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
}

Inheritance diagram for CityBuilderCore.CityInputActions:

Classes
interface	IPlayerActions
	Interface to implement callback methods for all input action callbacks associated with input actions defined by "Player" which allows adding and removing callbacks. More...
interface	IUIActions
	Interface to implement callback methods for all input action callbacks associated with input actions defined by "UI" which allows adding and removing callbacks. More...
struct	PlayerActions
	Provides access to input actions defined in input action map "Player". More...
struct	UIActions
	Provides access to input actions defined in input action map "UI". More...

Public Member Functions
	CityInputActions ()
	Constructs a new instance.
void	Dispose ()
	Destroys this asset and all associated InputAction instances.
bool	Contains (InputAction action)
IEnumerator< InputAction >	GetEnumerator ()
void	Enable ()
void	Disable ()
InputAction	FindAction (string actionNameOrId, bool throwIfNotFound=false)
int	FindBinding (InputBinding bindingMask, out InputAction action)

Properties
InputActionAsset	asset [get]
	Provides access to the underlying asset instance.
InputBinding?	bindingMask [get, set]
ReadOnlyArray< InputDevice >?	devices [get, set]
ReadOnlyArray< InputControlScheme >	controlSchemes [get]
IEnumerable< InputBinding >	bindings [get]
PlayerActions	Player [get]
	Provides a new PlayerActions instance referencing this action map.
UIActions	UI [get]
	Provides a new UIActions instance referencing this action map.
InputControlScheme	KeyboardMouseScheme [get]
	Provides access to the input control scheme.
InputControlScheme	GamepadScheme [get]
	Provides access to the input control scheme.
InputControlScheme	TouchScheme [get]
	Provides access to the input control scheme.

Property Documentation

GamepadScheme

InputControlScheme CityBuilderCore.CityInputActions.GamepadScheme

get

Provides access to the input control scheme.

See also

UnityEngine.InputSystem.InputControlScheme

KeyboardMouseScheme

InputControlScheme CityBuilderCore.CityInputActions.KeyboardMouseScheme

get

Provides access to the input control scheme.

See also

UnityEngine.InputSystem.InputControlScheme

TouchScheme

InputControlScheme CityBuilderCore.CityInputActions.TouchScheme

get

Provides access to the input control scheme.

See also

UnityEngine.InputSystem.InputControlScheme