gobj_is_disabled()

Checks if the given hgobj is disabled. A disabled hgobj is prevented from starting or playing.

C

Prototype

BOOL gobj_is_disabled(hgobj gobj);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance to check.

---

Return Value

Returns TRUE if the hgobj is disabled, otherwise returns FALSE.

Notes

A disabled hgobj cannot be started or played until it is explicitly enabled using gobj_enable().

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples