gobj_disable()#
Disables the given hgobj instance, preventing it from running or playing. If the object has a mt_disable method, it is executed; otherwise, gobj_stop_tree() is called.
Prototype
int gobj_disable(hgobj gobj);
Parameters
Key |
Type |
Description |
|---|---|---|
|
|
The |
Return Value
Returns 0 on success, or -1 if the object is already disabled or an error occurs.
Notes
If the object is already disabled, a warning is logged, and no action is taken.
Prototype
// Not applicable in JS
Prototype
# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples