Class PlayerInputPermissions

Contains APIs to enable/disable player input permissions.

Properties

cameraEnabled: boolean

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

movementEnabled: boolean

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

isPermissionCategoryEnabled(
permissionCategory: InputPermissionCategory,
): boolean
Beta
Parameters
- permissionCategory: InputPermissionCategory
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(
permissionCategory: InputPermissionCategory,
isEnabled: boolean,
): void
Beta
Parameters
- permissionCategory: InputPermissionCategory
- isEnabled: boolean
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.