Interface IUiController<TAction, TContext>

Interface for a UI controller.

Namespace: Serenity.Ui.Application.Interfaces.Controllers

Assembly: Serenity.Ui.Application.dll

Syntax

public interface IUiController<TAction, TContext> : IController, IFoundationSettings where TAction : IDisposable

Type Parameters

Name	Description
TAction
TContext

Properties

IsInitialized

Gets a value indicating whether the controller is initialized.

Declaration

bool IsInitialized { get; }

Property Value

Type	Description
bool	True if the controller is initialized; otherwise, false.

Methods

Cancel()

Cancels the UI controller.

Declaration

void Cancel()

GetTimer()

Gets the timer component.

Declaration

IComponent GetTimer()

Returns

Type	Description
IComponent	The timer component.

Initialize(string, string, float, int, float, IPlayerInputService, IPlayerInputActionBindingFactory<TAction, TContext>, IComponent, object, ILogService)

Initializes the UI controller.

Declaration

void Initialize(string id, string guid, float changeInterval, int consecutiveChangesBeforeSpeedUp, float fastChangeInterval, IPlayerInputService playerInputService, IPlayerInputActionBindingFactory<TAction, TContext> playerInputActionBindingFactory, IComponent timer, object playerInput, ILogService logService)

Parameters

Type	Name	Description
string	id	The identifier for the controller.
string	guid	The GUID for the controller.
float	changeInterval	The interval for input changes.
int	consecutiveChangesBeforeSpeedUp	The number of consecutive changes before speeding up.
float	fastChangeInterval	The interval for fast input changes.
IPlayerInputService	playerInputService	The player input service.
IPlayerInputActionBindingFactory<TAction, TContext>	playerInputActionBindingFactory	The factory for creating player input action bindings.
IComponent	timer	The timer component.
object	playerInput	The player input handle (e.g., a PlayerInput component in Unity).
ILogService	logService	The log service.

Navigate(Vector3)

Navigates the UI controller.

Declaration

void Navigate(Vector3 direction)

Parameters

Type	Name	Description
Vector3	direction	The direction to navigate.

Submit()

Submits the UI controller.

Declaration

void Submit()