Class PlayerInputPermissions

Contains APIs to enable/disable player input permissions.

Constructors

constructor

Properties

cameraEnabled movementEnabled

Methods

isPermissionCategoryEnabled setPermissionCategory

Constructors

Privateconstructor

Properties

cameraEnabled

cameraEnabled: boolean

Deprecated

This property is deprecated and will be removed in 2.0.0.

Remarks

Camera input permissions for the player. If set to true, input relating to camera movement is enabled for the player.

movementEnabled

movementEnabled: boolean

Deprecated

This property is deprecated and will be removed in 2.0.0.

Remarks

Movement input permissions for the player. If set to true input relating to movement is enabled for the player.

Methods

isPermissionCategoryEnabled

  • isPermissionCategoryEnabled(
        permissionCategory: InputPermissionCategory,
    ): boolean

    Parameters

    Returns boolean

    Remarks

    Returns true if an input permission is enabled.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

    Error

setPermissionCategory

  • setPermissionCategory(
        permissionCategory: InputPermissionCategory,
        isEnabled: boolean,
    ): void

    Parameters

    Returns void

    Remarks

    Enable or disable an input permission. When enabled the input will work, when disabled will not work.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods