logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Interface IPlayerInputServiceSettingsDefinition

    Definition of settings for the player input service.

    Namespace: Serenity.InputGateway.Domain.Interfaces
    Assembly: Serenity.InputGateway.Application.dll
    Syntax
    public interface IPlayerInputServiceSettingsDefinition : IFoundationSettings
    Remarks

    Implementations should be serializable by the foundation.

    Properties

    ChangeInterval

    Gets or sets the interval between input changes.

    Declaration
    float ChangeInterval { get; set; }
    Property Value
    Type Description
    float

    The change interval as a float.

    ChangeIntervalFast

    Gets or sets the fast change interval after speeding up.

    Declaration
    float ChangeIntervalFast { get; set; }
    Property Value
    Type Description
    float

    The fast change interval as a float.

    ConsecutiveChangesBeforeSpeedUp

    Gets or sets the number of consecutive changes before speeding up.

    Declaration
    int ConsecutiveChangesBeforeSpeedUp { get; set; }
    Property Value
    Type Description
    int

    The number of consecutive changes before speeding up.

    InputAsset

    Gets or sets the input asset (e.g., InputActionAsset in Unity).

    Declaration
    object InputAsset { get; set; }
    Property Value
    Type Description
    object

    The input asset as an object.

    OnPrimaryJoinTask

    Task to call when a new player joins as primary.

    Declaration
    IReflectionCallTaskDefinition OnPrimaryJoinTask { get; set; }
    Property Value
    Type Description
    IReflectionCallTaskDefinition

    The task to call when a new player joins as primary.

    Routing

    Settings for routing UI input to player input handlers.

    Declaration
    IPlayerInputRoutingSettings Routing { get; set; }
    Property Value
    Type Description
    IPlayerInputRoutingSettings

    The routing settings.

    UiActionMapName

    Gets or sets the name of the action map used for UI input.

    Declaration
    string UiActionMapName { get; set; }
    Property Value
    Type Description
    string

    The name of the action map used for UI input.

    UiCancelActionName

    Gets or sets the name of the action used for UI cancel.

    Declaration
    string UiCancelActionName { get; set; }
    Property Value
    Type Description
    string

    The name of the action used for UI cancel.

    UiNavigateActionName

    Gets or sets the name of the action used for UI navigation.

    Declaration
    string UiNavigateActionName { get; set; }
    Property Value
    Type Description
    string

    The name of the action used for UI navigation.

    UiSubmitActionName

    Gets or sets the name of the action used for UI submit.

    Declaration
    string UiSubmitActionName { get; set; }
    Property Value
    Type Description
    string

    The name of the action used for UI submit.

    In this article
    © 2026 Serenity. All Rights Reserved