Loading...
Searching...
No Matches
AdventureSouls.SoulsInput.UIActions Struct Reference

Detailed Description

Provides access to input actions defined in input action map "UI".

Public Member Functions

 UIActions (@SoulsInput wrapper)
 Construct a new instance of the input action map wrapper class.
 
InputActionMap Get ()
 Provides access to the underlying input action map instance.
 
void Enable ()
 
void Disable ()
 
void AddCallbacks (IUIActions instance)
 Adds InputAction.started, InputAction.performed and InputAction.canceled callbacks provided via on all input actions contained in this map.
 
void RemoveCallbacks (IUIActions instance)
 Unregisters and unregisters all input action callbacks via UIActions.UnregisterCallbacks(IUIActions).
 
void SetCallbacks (IUIActions instance)
 Replaces all existing callback instances and previously registered input action callbacks associated with them with callbacks provided via .
 

Static Public Member Functions

static implicit operator InputActionMap (UIActions set)
 Implicitly converts an to an instance.
 

Properties

InputAction Navigate [get]
 Provides access to the underlying input action "UI/Navigate".
 
InputAction NavigateTitle [get]
 Provides access to the underlying input action "UI/NavigateTitle".
 
InputAction Submit [get]
 Provides access to the underlying input action "UI/Submit".
 
InputAction SubmitTitle [get]
 Provides access to the underlying input action "UI/SubmitTitle".
 
InputAction Cancel [get]
 Provides access to the underlying input action "UI/Cancel".
 
InputAction Point [get]
 Provides access to the underlying input action "UI/Point".
 
InputAction Click [get]
 Provides access to the underlying input action "UI/Click".
 
InputAction ScrollWheel [get]
 Provides access to the underlying input action "UI/ScrollWheel".
 
InputAction MiddleClick [get]
 Provides access to the underlying input action "UI/MiddleClick".
 
InputAction RightClick [get]
 Provides access to the underlying input action "UI/RightClick".
 
bool enabled [get]
 

Member Function Documentation

◆ AddCallbacks()

void AdventureSouls.SoulsInput.UIActions.AddCallbacks ( IUIActions instance)
inline

Adds InputAction.started, InputAction.performed and InputAction.canceled callbacks provided via on all input actions contained in this map.

Parameters
instanceCallback instance.

If instance is null or instance have already been added this method does nothing.

See also
UIActions

◆ RemoveCallbacks()

void AdventureSouls.SoulsInput.UIActions.RemoveCallbacks ( IUIActions instance)
inline

Unregisters and unregisters all input action callbacks via UIActions.UnregisterCallbacks(IUIActions).

See also
UIActions.UnregisterCallbacks(IUIActions)

◆ SetCallbacks()

void AdventureSouls.SoulsInput.UIActions.SetCallbacks ( IUIActions instance)
inline

Replaces all existing callback instances and previously registered input action callbacks associated with them with callbacks provided via .

If instance is null, calling this method will only unregister all existing callbacks but not register any new callbacks.

See also
UIActions.AddCallbacks(IUIActions), UIActions.RemoveCallbacks(IUIActions), UIActions.UnregisterCallbacks(IUIActions)