SetKeyHangerEnabled - MXC Products Docs

Enables or disables a keyhanger. A disabled keyhanger is removed from the world but kept in the database and stays removed after a restart, enabling it recreates it.

Argument	Data Type	Needed	Default	Description
`hangerId`	number	✅	`-`	The id of the keyhanger
`enabled`	boolean	✅	`-`	True to recreate the keyhanger, false to remove it from the world

Returns

Type	Description
boolean	true if the keyhanger status has been updated, false otherwise
string \| nil	The error message if the status has not been updated (`KeyHanger not found`, or `Invalid keyhanger data` if the keyhanger could not be recreated, for example because its model has been removed from the config)

Example

exports["utility_keyhanger"]:SetKeyHangerEnabled(hangerId, false)