From 26129004d1932dd094f95ad0269cadb1e176653f Mon Sep 17 00:00:00 2001 From: jyelon Date: Wed, 16 Aug 2023 13:45:12 -0400 Subject: [PATCH] Improve commentary about get_animation_queues --- luprex/cpp/core/enginewrapper.hpp | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/luprex/cpp/core/enginewrapper.hpp b/luprex/cpp/core/enginewrapper.hpp index e69a2cc9..d2946753 100644 --- a/luprex/cpp/core/enginewrapper.hpp +++ b/luprex/cpp/core/enginewrapper.hpp @@ -123,10 +123,16 @@ struct EngineWrapper { // Get the animation queues for the specified tangibles. // - // You must supply an array of tangible IDs. This returns the serialized - // animation queues for all specified tangibles as strings. The serialized - // format is documented in header file animqueue.hpp. The returned pointers - // remain valid until the next call to get_animation_queues. + // You must supply an array of tangible IDs. For each tangible, returns the + // animation queue as a serialized string. The serialized format is + // documented in header file animqueue.hpp. + // + // 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);