Class PlayerInputPermissions

Contains APIs to enable/disable player input permissions.

Index

Constructors

Methods

isPermissionCategoryEnabled setPermissionCategory

Constructors

`Private`constructor

new PlayerInputPermissions(): PlayerInputPermissions
Returns PlayerInputPermissions

Methods

isPermissionCategoryEnabled

isPermissionCategoryEnabled(
permissionCategory: InputPermissionCategory,
): boolean
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

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