Class PlayerInputPermissions

Contains APIs to enable/disable player input permissions.

Hierarchy

PlayerInputPermissions

Index

Constructors

Methods

isPermissionCategoryEnabled setPermissionCategory

Constructors

`Private` constructor

new PlayerInputPermissions(): PlayerInputPermissions
Returns PlayerInputPermissions
- Defined in tmp/package/index.d.ts:15163

Methods

isPermissionCategoryEnabled

isPermissionCategoryEnabled(permissionCategory): boolean
Parameters
- permissionCategory: InputPermissionCategory
Returns boolean

Rc

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
- Defined in tmp/package/index.d.ts:15175

setPermissionCategory

setPermissionCategory(permissionCategory, isEnabled): void
Parameters
- permissionCategory: InputPermissionCategory
- isEnabled: boolean
Returns void

Rc

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.
- Defined in tmp/package/index.d.ts:15186