Improve commentary about get_animation_queues
This commit is contained in:
@@ -123,10 +123,16 @@ struct EngineWrapper {
|
|||||||
|
|
||||||
// Get the animation queues for the specified tangibles.
|
// Get the animation queues for the specified tangibles.
|
||||||
//
|
//
|
||||||
// You must supply an array of tangible IDs. This returns the serialized
|
// You must supply an array of tangible IDs. For each tangible, returns the
|
||||||
// animation queues for all specified tangibles as strings. The serialized
|
// animation queue as a serialized string. The serialized format is
|
||||||
// format is documented in header file animqueue.hpp. The returned pointers
|
// documented in header file animqueue.hpp.
|
||||||
// remain valid until the next call to get_animation_queues.
|
//
|
||||||
|
// You must also supply a buffer for the string lengths, and a buffer for
|
||||||
|
// the string pointers. Both buffers must have space for number of
|
||||||
|
// tangibles specified in the call.
|
||||||
|
//
|
||||||
|
// The returned character pointers remain valid until the next call to
|
||||||
|
// get_animation_queues.
|
||||||
//
|
//
|
||||||
void (*get_animation_queues)(EngineWrapper *w, uint32_t count, const int64_t *ids, uint32_t *lengths, const char **strings);
|
void (*get_animation_queues)(EngineWrapper *w, uint32_t count, const int64_t *ids, uint32_t *lengths, const char **strings);
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user