gobj_stop()

Stops the execution of the given gobj instance, ensuring it is no longer running. If the gobj is playing, it will be paused before stopping.

C

Prototype

int gobj_stop(
    hgobj gobj
);

Parameters

Key	Type	Description
gobj	hgobj	The gobj instance to be stopped.

---

Return Value

Returns 0 on success, or -1 if the gobj is already stopped, destroying, or invalid.

Notes

If the gobj is playing, it will be paused before stopping. If the gobj is already stopped, an error is logged.

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