gdextension_interface.h 116 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872
  1. /**************************************************************************/
  2. /* gdextension_interface.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef GDEXTENSION_INTERFACE_H
  31. #define GDEXTENSION_INTERFACE_H
  32. /* This is a C class header, you can copy it and use it directly in your own binders.
  33. * Together with the JSON file, you should be able to generate any binder.
  34. */
  35. #include <stddef.h>
  36. #include <stdint.h>
  37. #ifndef __cplusplus
  38. typedef uint32_t char32_t;
  39. typedef uint16_t char16_t;
  40. #endif
  41. #ifdef __cplusplus
  42. extern "C" {
  43. #endif
  44. /* VARIANT TYPES */
  45. typedef enum {
  46. GDEXTENSION_VARIANT_TYPE_NIL,
  47. /* atomic types */
  48. GDEXTENSION_VARIANT_TYPE_BOOL,
  49. GDEXTENSION_VARIANT_TYPE_INT,
  50. GDEXTENSION_VARIANT_TYPE_FLOAT,
  51. GDEXTENSION_VARIANT_TYPE_STRING,
  52. /* math types */
  53. GDEXTENSION_VARIANT_TYPE_VECTOR2,
  54. GDEXTENSION_VARIANT_TYPE_VECTOR2I,
  55. GDEXTENSION_VARIANT_TYPE_RECT2,
  56. GDEXTENSION_VARIANT_TYPE_RECT2I,
  57. GDEXTENSION_VARIANT_TYPE_VECTOR3,
  58. GDEXTENSION_VARIANT_TYPE_VECTOR3I,
  59. GDEXTENSION_VARIANT_TYPE_TRANSFORM2D,
  60. GDEXTENSION_VARIANT_TYPE_VECTOR4,
  61. GDEXTENSION_VARIANT_TYPE_VECTOR4I,
  62. GDEXTENSION_VARIANT_TYPE_PLANE,
  63. GDEXTENSION_VARIANT_TYPE_QUATERNION,
  64. GDEXTENSION_VARIANT_TYPE_AABB,
  65. GDEXTENSION_VARIANT_TYPE_BASIS,
  66. GDEXTENSION_VARIANT_TYPE_TRANSFORM3D,
  67. GDEXTENSION_VARIANT_TYPE_PROJECTION,
  68. /* misc types */
  69. GDEXTENSION_VARIANT_TYPE_COLOR,
  70. GDEXTENSION_VARIANT_TYPE_STRING_NAME,
  71. GDEXTENSION_VARIANT_TYPE_NODE_PATH,
  72. GDEXTENSION_VARIANT_TYPE_RID,
  73. GDEXTENSION_VARIANT_TYPE_OBJECT,
  74. GDEXTENSION_VARIANT_TYPE_CALLABLE,
  75. GDEXTENSION_VARIANT_TYPE_SIGNAL,
  76. GDEXTENSION_VARIANT_TYPE_DICTIONARY,
  77. GDEXTENSION_VARIANT_TYPE_ARRAY,
  78. /* typed arrays */
  79. GDEXTENSION_VARIANT_TYPE_PACKED_BYTE_ARRAY,
  80. GDEXTENSION_VARIANT_TYPE_PACKED_INT32_ARRAY,
  81. GDEXTENSION_VARIANT_TYPE_PACKED_INT64_ARRAY,
  82. GDEXTENSION_VARIANT_TYPE_PACKED_FLOAT32_ARRAY,
  83. GDEXTENSION_VARIANT_TYPE_PACKED_FLOAT64_ARRAY,
  84. GDEXTENSION_VARIANT_TYPE_PACKED_STRING_ARRAY,
  85. GDEXTENSION_VARIANT_TYPE_PACKED_VECTOR2_ARRAY,
  86. GDEXTENSION_VARIANT_TYPE_PACKED_VECTOR3_ARRAY,
  87. GDEXTENSION_VARIANT_TYPE_PACKED_COLOR_ARRAY,
  88. GDEXTENSION_VARIANT_TYPE_VARIANT_MAX
  89. } GDExtensionVariantType;
  90. typedef enum {
  91. /* comparison */
  92. GDEXTENSION_VARIANT_OP_EQUAL,
  93. GDEXTENSION_VARIANT_OP_NOT_EQUAL,
  94. GDEXTENSION_VARIANT_OP_LESS,
  95. GDEXTENSION_VARIANT_OP_LESS_EQUAL,
  96. GDEXTENSION_VARIANT_OP_GREATER,
  97. GDEXTENSION_VARIANT_OP_GREATER_EQUAL,
  98. /* mathematic */
  99. GDEXTENSION_VARIANT_OP_ADD,
  100. GDEXTENSION_VARIANT_OP_SUBTRACT,
  101. GDEXTENSION_VARIANT_OP_MULTIPLY,
  102. GDEXTENSION_VARIANT_OP_DIVIDE,
  103. GDEXTENSION_VARIANT_OP_NEGATE,
  104. GDEXTENSION_VARIANT_OP_POSITIVE,
  105. GDEXTENSION_VARIANT_OP_MODULE,
  106. GDEXTENSION_VARIANT_OP_POWER,
  107. /* bitwise */
  108. GDEXTENSION_VARIANT_OP_SHIFT_LEFT,
  109. GDEXTENSION_VARIANT_OP_SHIFT_RIGHT,
  110. GDEXTENSION_VARIANT_OP_BIT_AND,
  111. GDEXTENSION_VARIANT_OP_BIT_OR,
  112. GDEXTENSION_VARIANT_OP_BIT_XOR,
  113. GDEXTENSION_VARIANT_OP_BIT_NEGATE,
  114. /* logic */
  115. GDEXTENSION_VARIANT_OP_AND,
  116. GDEXTENSION_VARIANT_OP_OR,
  117. GDEXTENSION_VARIANT_OP_XOR,
  118. GDEXTENSION_VARIANT_OP_NOT,
  119. /* containment */
  120. GDEXTENSION_VARIANT_OP_IN,
  121. GDEXTENSION_VARIANT_OP_MAX
  122. } GDExtensionVariantOperator;
  123. // In this API there are multiple functions which expect the caller to pass a pointer
  124. // on return value as parameter.
  125. // In order to make it clear if the caller should initialize the return value or not
  126. // we have two flavor of types:
  127. // - `GDExtensionXXXPtr` for pointer on an initialized value
  128. // - `GDExtensionUninitializedXXXPtr` for pointer on uninitialized value
  129. //
  130. // Notes:
  131. // - Not respecting those requirements can seems harmless, but will lead to unexpected
  132. // segfault or memory leak (for instance with a specific compiler/OS, or when two
  133. // native extensions start doing ptrcall on each other).
  134. // - Initialization must be done with the function pointer returned by `variant_get_ptr_constructor`,
  135. // zero-initializing the variable should not be considered a valid initialization method here !
  136. // - Some types have no destructor (see `extension_api.json`'s `has_destructor` field), for
  137. // them it is always safe to skip the constructor for the return value if you are in a hurry ;-)
  138. typedef void *GDExtensionVariantPtr;
  139. typedef const void *GDExtensionConstVariantPtr;
  140. typedef void *GDExtensionUninitializedVariantPtr;
  141. typedef void *GDExtensionStringNamePtr;
  142. typedef const void *GDExtensionConstStringNamePtr;
  143. typedef void *GDExtensionUninitializedStringNamePtr;
  144. typedef void *GDExtensionStringPtr;
  145. typedef const void *GDExtensionConstStringPtr;
  146. typedef void *GDExtensionUninitializedStringPtr;
  147. typedef void *GDExtensionObjectPtr;
  148. typedef const void *GDExtensionConstObjectPtr;
  149. typedef void *GDExtensionUninitializedObjectPtr;
  150. typedef void *GDExtensionTypePtr;
  151. typedef const void *GDExtensionConstTypePtr;
  152. typedef void *GDExtensionUninitializedTypePtr;
  153. typedef const void *GDExtensionMethodBindPtr;
  154. typedef int64_t GDExtensionInt;
  155. typedef uint8_t GDExtensionBool;
  156. typedef uint64_t GDObjectInstanceID;
  157. typedef void *GDExtensionRefPtr;
  158. typedef const void *GDExtensionConstRefPtr;
  159. /* VARIANT DATA I/O */
  160. typedef enum {
  161. GDEXTENSION_CALL_OK,
  162. GDEXTENSION_CALL_ERROR_INVALID_METHOD,
  163. GDEXTENSION_CALL_ERROR_INVALID_ARGUMENT, // Expected a different variant type.
  164. GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS, // Expected lower number of arguments.
  165. GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS, // Expected higher number of arguments.
  166. GDEXTENSION_CALL_ERROR_INSTANCE_IS_NULL,
  167. GDEXTENSION_CALL_ERROR_METHOD_NOT_CONST, // Used for const call.
  168. } GDExtensionCallErrorType;
  169. typedef struct {
  170. GDExtensionCallErrorType error;
  171. int32_t argument;
  172. int32_t expected;
  173. } GDExtensionCallError;
  174. typedef void (*GDExtensionVariantFromTypeConstructorFunc)(GDExtensionUninitializedVariantPtr, GDExtensionTypePtr);
  175. typedef void (*GDExtensionTypeFromVariantConstructorFunc)(GDExtensionUninitializedTypePtr, GDExtensionVariantPtr);
  176. typedef void (*GDExtensionPtrOperatorEvaluator)(GDExtensionConstTypePtr p_left, GDExtensionConstTypePtr p_right, GDExtensionTypePtr r_result);
  177. typedef void (*GDExtensionPtrBuiltInMethod)(GDExtensionTypePtr p_base, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_return, int p_argument_count);
  178. typedef void (*GDExtensionPtrConstructor)(GDExtensionUninitializedTypePtr p_base, const GDExtensionConstTypePtr *p_args);
  179. typedef void (*GDExtensionPtrDestructor)(GDExtensionTypePtr p_base);
  180. typedef void (*GDExtensionPtrSetter)(GDExtensionTypePtr p_base, GDExtensionConstTypePtr p_value);
  181. typedef void (*GDExtensionPtrGetter)(GDExtensionConstTypePtr p_base, GDExtensionTypePtr r_value);
  182. typedef void (*GDExtensionPtrIndexedSetter)(GDExtensionTypePtr p_base, GDExtensionInt p_index, GDExtensionConstTypePtr p_value);
  183. typedef void (*GDExtensionPtrIndexedGetter)(GDExtensionConstTypePtr p_base, GDExtensionInt p_index, GDExtensionTypePtr r_value);
  184. typedef void (*GDExtensionPtrKeyedSetter)(GDExtensionTypePtr p_base, GDExtensionConstTypePtr p_key, GDExtensionConstTypePtr p_value);
  185. typedef void (*GDExtensionPtrKeyedGetter)(GDExtensionConstTypePtr p_base, GDExtensionConstTypePtr p_key, GDExtensionTypePtr r_value);
  186. typedef uint32_t (*GDExtensionPtrKeyedChecker)(GDExtensionConstVariantPtr p_base, GDExtensionConstVariantPtr p_key);
  187. typedef void (*GDExtensionPtrUtilityFunction)(GDExtensionTypePtr r_return, const GDExtensionConstTypePtr *p_args, int p_argument_count);
  188. typedef GDExtensionObjectPtr (*GDExtensionClassConstructor)();
  189. typedef void *(*GDExtensionInstanceBindingCreateCallback)(void *p_token, void *p_instance);
  190. typedef void (*GDExtensionInstanceBindingFreeCallback)(void *p_token, void *p_instance, void *p_binding);
  191. typedef GDExtensionBool (*GDExtensionInstanceBindingReferenceCallback)(void *p_token, void *p_binding, GDExtensionBool p_reference);
  192. typedef struct {
  193. GDExtensionInstanceBindingCreateCallback create_callback;
  194. GDExtensionInstanceBindingFreeCallback free_callback;
  195. GDExtensionInstanceBindingReferenceCallback reference_callback;
  196. } GDExtensionInstanceBindingCallbacks;
  197. /* EXTENSION CLASSES */
  198. typedef void *GDExtensionClassInstancePtr;
  199. typedef GDExtensionBool (*GDExtensionClassSet)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
  200. typedef GDExtensionBool (*GDExtensionClassGet)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  201. typedef uint64_t (*GDExtensionClassGetRID)(GDExtensionClassInstancePtr p_instance);
  202. typedef struct {
  203. GDExtensionVariantType type;
  204. GDExtensionStringNamePtr name;
  205. GDExtensionStringNamePtr class_name;
  206. uint32_t hint; // Bitfield of `PropertyHint` (defined in `extension_api.json`).
  207. GDExtensionStringPtr hint_string;
  208. uint32_t usage; // Bitfield of `PropertyUsageFlags` (defined in `extension_api.json`).
  209. } GDExtensionPropertyInfo;
  210. typedef struct {
  211. GDExtensionStringNamePtr name;
  212. GDExtensionPropertyInfo return_value;
  213. uint32_t flags; // Bitfield of `GDExtensionClassMethodFlags`.
  214. int32_t id;
  215. /* Arguments: `default_arguments` is an array of size `argument_count`. */
  216. uint32_t argument_count;
  217. GDExtensionPropertyInfo *arguments;
  218. /* Default arguments: `default_arguments` is an array of size `default_argument_count`. */
  219. uint32_t default_argument_count;
  220. GDExtensionVariantPtr *default_arguments;
  221. } GDExtensionMethodInfo;
  222. typedef const GDExtensionPropertyInfo *(*GDExtensionClassGetPropertyList)(GDExtensionClassInstancePtr p_instance, uint32_t *r_count);
  223. typedef void (*GDExtensionClassFreePropertyList)(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list);
  224. typedef void (*GDExtensionClassFreePropertyList2)(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count);
  225. typedef GDExtensionBool (*GDExtensionClassPropertyCanRevert)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name);
  226. typedef GDExtensionBool (*GDExtensionClassPropertyGetRevert)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  227. typedef GDExtensionBool (*GDExtensionClassValidateProperty)(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property);
  228. typedef void (*GDExtensionClassNotification)(GDExtensionClassInstancePtr p_instance, int32_t p_what); // Deprecated. Use GDExtensionClassNotification2 instead.
  229. typedef void (*GDExtensionClassNotification2)(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
  230. typedef void (*GDExtensionClassToString)(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr p_out);
  231. typedef void (*GDExtensionClassReference)(GDExtensionClassInstancePtr p_instance);
  232. typedef void (*GDExtensionClassUnreference)(GDExtensionClassInstancePtr p_instance);
  233. typedef void (*GDExtensionClassCallVirtual)(GDExtensionClassInstancePtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  234. typedef GDExtensionObjectPtr (*GDExtensionClassCreateInstance)(void *p_class_userdata);
  235. typedef void (*GDExtensionClassFreeInstance)(void *p_class_userdata, GDExtensionClassInstancePtr p_instance);
  236. typedef GDExtensionClassInstancePtr (*GDExtensionClassRecreateInstance)(void *p_class_userdata, GDExtensionObjectPtr p_object);
  237. typedef GDExtensionClassCallVirtual (*GDExtensionClassGetVirtual)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name);
  238. typedef void *(*GDExtensionClassGetVirtualCallData)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name);
  239. typedef void (*GDExtensionClassCallVirtualWithData)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, void *p_virtual_call_userdata, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  240. typedef struct {
  241. GDExtensionBool is_virtual;
  242. GDExtensionBool is_abstract;
  243. GDExtensionClassSet set_func;
  244. GDExtensionClassGet get_func;
  245. GDExtensionClassGetPropertyList get_property_list_func;
  246. GDExtensionClassFreePropertyList free_property_list_func;
  247. GDExtensionClassPropertyCanRevert property_can_revert_func;
  248. GDExtensionClassPropertyGetRevert property_get_revert_func;
  249. GDExtensionClassNotification notification_func;
  250. GDExtensionClassToString to_string_func;
  251. GDExtensionClassReference reference_func;
  252. GDExtensionClassUnreference unreference_func;
  253. GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  254. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  255. GDExtensionClassGetVirtual get_virtual_func; // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  256. GDExtensionClassGetRID get_rid_func;
  257. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  258. } GDExtensionClassCreationInfo; // Deprecated. Use GDExtensionClassCreationInfo3 instead.
  259. typedef struct {
  260. GDExtensionBool is_virtual;
  261. GDExtensionBool is_abstract;
  262. GDExtensionBool is_exposed;
  263. GDExtensionClassSet set_func;
  264. GDExtensionClassGet get_func;
  265. GDExtensionClassGetPropertyList get_property_list_func;
  266. GDExtensionClassFreePropertyList free_property_list_func;
  267. GDExtensionClassPropertyCanRevert property_can_revert_func;
  268. GDExtensionClassPropertyGetRevert property_get_revert_func;
  269. GDExtensionClassValidateProperty validate_property_func;
  270. GDExtensionClassNotification2 notification_func;
  271. GDExtensionClassToString to_string_func;
  272. GDExtensionClassReference reference_func;
  273. GDExtensionClassUnreference unreference_func;
  274. GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  275. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  276. GDExtensionClassRecreateInstance recreate_instance_func;
  277. // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  278. GDExtensionClassGetVirtual get_virtual_func;
  279. // Paired with `call_virtual_with_data_func`, this is an alternative to `get_virtual_func` for extensions that
  280. // need or benefit from extra data when calling virtual functions.
  281. // Returns user data that will be passed to `call_virtual_with_data_func`.
  282. // Returning `NULL` from this function signals to Godot that the virtual function is not overridden.
  283. // Data returned from this function should be managed by the extension and must be valid until the extension is deinitialized.
  284. // You should supply either `get_virtual_func`, or `get_virtual_call_data_func` with `call_virtual_with_data_func`.
  285. GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  286. // Used to call virtual functions when `get_virtual_call_data_func` is not null.
  287. GDExtensionClassCallVirtualWithData call_virtual_with_data_func;
  288. GDExtensionClassGetRID get_rid_func;
  289. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  290. } GDExtensionClassCreationInfo2; // Deprecated. Use GDExtensionClassCreationInfo3 instead.
  291. typedef struct {
  292. GDExtensionBool is_virtual;
  293. GDExtensionBool is_abstract;
  294. GDExtensionBool is_exposed;
  295. GDExtensionBool is_runtime;
  296. GDExtensionClassSet set_func;
  297. GDExtensionClassGet get_func;
  298. GDExtensionClassGetPropertyList get_property_list_func;
  299. GDExtensionClassFreePropertyList2 free_property_list_func;
  300. GDExtensionClassPropertyCanRevert property_can_revert_func;
  301. GDExtensionClassPropertyGetRevert property_get_revert_func;
  302. GDExtensionClassValidateProperty validate_property_func;
  303. GDExtensionClassNotification2 notification_func;
  304. GDExtensionClassToString to_string_func;
  305. GDExtensionClassReference reference_func;
  306. GDExtensionClassUnreference unreference_func;
  307. GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  308. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  309. GDExtensionClassRecreateInstance recreate_instance_func;
  310. // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  311. GDExtensionClassGetVirtual get_virtual_func;
  312. // Paired with `call_virtual_with_data_func`, this is an alternative to `get_virtual_func` for extensions that
  313. // need or benefit from extra data when calling virtual functions.
  314. // Returns user data that will be passed to `call_virtual_with_data_func`.
  315. // Returning `NULL` from this function signals to Godot that the virtual function is not overridden.
  316. // Data returned from this function should be managed by the extension and must be valid until the extension is deinitialized.
  317. // You should supply either `get_virtual_func`, or `get_virtual_call_data_func` with `call_virtual_with_data_func`.
  318. GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  319. // Used to call virtual functions when `get_virtual_call_data_func` is not null.
  320. GDExtensionClassCallVirtualWithData call_virtual_with_data_func;
  321. GDExtensionClassGetRID get_rid_func;
  322. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  323. } GDExtensionClassCreationInfo3;
  324. typedef void *GDExtensionClassLibraryPtr;
  325. /* Method */
  326. typedef enum {
  327. GDEXTENSION_METHOD_FLAG_NORMAL = 1,
  328. GDEXTENSION_METHOD_FLAG_EDITOR = 2,
  329. GDEXTENSION_METHOD_FLAG_CONST = 4,
  330. GDEXTENSION_METHOD_FLAG_VIRTUAL = 8,
  331. GDEXTENSION_METHOD_FLAG_VARARG = 16,
  332. GDEXTENSION_METHOD_FLAG_STATIC = 32,
  333. GDEXTENSION_METHOD_FLAGS_DEFAULT = GDEXTENSION_METHOD_FLAG_NORMAL,
  334. } GDExtensionClassMethodFlags;
  335. typedef enum {
  336. GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE,
  337. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT8,
  338. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT16,
  339. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT32,
  340. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT64,
  341. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT8,
  342. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT16,
  343. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT32,
  344. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT64,
  345. GDEXTENSION_METHOD_ARGUMENT_METADATA_REAL_IS_FLOAT,
  346. GDEXTENSION_METHOD_ARGUMENT_METADATA_REAL_IS_DOUBLE
  347. } GDExtensionClassMethodArgumentMetadata;
  348. typedef void (*GDExtensionClassMethodCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
  349. typedef void (*GDExtensionClassMethodValidatedCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDExtensionConstVariantPtr *p_args, GDExtensionVariantPtr r_return);
  350. typedef void (*GDExtensionClassMethodPtrCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  351. typedef struct {
  352. GDExtensionStringNamePtr name;
  353. void *method_userdata;
  354. GDExtensionClassMethodCall call_func;
  355. GDExtensionClassMethodPtrCall ptrcall_func;
  356. uint32_t method_flags; // Bitfield of `GDExtensionClassMethodFlags`.
  357. /* If `has_return_value` is false, `return_value_info` and `return_value_metadata` are ignored.
  358. *
  359. * @todo Consider dropping `has_return_value` and making the other two properties match `GDExtensionMethodInfo` and `GDExtensionClassVirtualMethod` for consistency in future version of this struct.
  360. */
  361. GDExtensionBool has_return_value;
  362. GDExtensionPropertyInfo *return_value_info;
  363. GDExtensionClassMethodArgumentMetadata return_value_metadata;
  364. /* Arguments: `arguments_info` and `arguments_metadata` are array of size `argument_count`.
  365. * Name and hint information for the argument can be omitted in release builds. Class name should always be present if it applies.
  366. *
  367. * @todo Consider renaming `arguments_info` to `arguments` for consistency in future version of this struct.
  368. */
  369. uint32_t argument_count;
  370. GDExtensionPropertyInfo *arguments_info;
  371. GDExtensionClassMethodArgumentMetadata *arguments_metadata;
  372. /* Default arguments: `default_arguments` is an array of size `default_argument_count`. */
  373. uint32_t default_argument_count;
  374. GDExtensionVariantPtr *default_arguments;
  375. } GDExtensionClassMethodInfo;
  376. typedef struct {
  377. GDExtensionStringNamePtr name;
  378. uint32_t method_flags; // Bitfield of `GDExtensionClassMethodFlags`.
  379. GDExtensionPropertyInfo return_value;
  380. GDExtensionClassMethodArgumentMetadata return_value_metadata;
  381. uint32_t argument_count;
  382. GDExtensionPropertyInfo *arguments;
  383. GDExtensionClassMethodArgumentMetadata *arguments_metadata;
  384. } GDExtensionClassVirtualMethodInfo;
  385. typedef void (*GDExtensionCallableCustomCall)(void *callable_userdata, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
  386. typedef GDExtensionBool (*GDExtensionCallableCustomIsValid)(void *callable_userdata);
  387. typedef void (*GDExtensionCallableCustomFree)(void *callable_userdata);
  388. typedef uint32_t (*GDExtensionCallableCustomHash)(void *callable_userdata);
  389. typedef GDExtensionBool (*GDExtensionCallableCustomEqual)(void *callable_userdata_a, void *callable_userdata_b);
  390. typedef GDExtensionBool (*GDExtensionCallableCustomLessThan)(void *callable_userdata_a, void *callable_userdata_b);
  391. typedef void (*GDExtensionCallableCustomToString)(void *callable_userdata, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
  392. typedef GDExtensionInt (*GDExtensionCallableCustomGetArgumentCount)(void *callable_userdata, GDExtensionBool *r_is_valid);
  393. typedef struct {
  394. /* Only `call_func` and `token` are strictly required, however, `object_id` should be passed if its not a static method.
  395. *
  396. * `token` should point to an address that uniquely identifies the GDExtension (for example, the
  397. * `GDExtensionClassLibraryPtr` passed to the entry symbol function.
  398. *
  399. * `hash_func`, `equal_func`, and `less_than_func` are optional. If not provided both `call_func` and
  400. * `callable_userdata` together are used as the identity of the callable for hashing and comparison purposes.
  401. *
  402. * The hash returned by `hash_func` is cached, `hash_func` will not be called more than once per callable.
  403. *
  404. * `is_valid_func` is necessary if the validity of the callable can change before destruction.
  405. *
  406. * `free_func` is necessary if `callable_userdata` needs to be cleaned up when the callable is freed.
  407. */
  408. void *callable_userdata;
  409. void *token;
  410. GDObjectInstanceID object_id;
  411. GDExtensionCallableCustomCall call_func;
  412. GDExtensionCallableCustomIsValid is_valid_func;
  413. GDExtensionCallableCustomFree free_func;
  414. GDExtensionCallableCustomHash hash_func;
  415. GDExtensionCallableCustomEqual equal_func;
  416. GDExtensionCallableCustomLessThan less_than_func;
  417. GDExtensionCallableCustomToString to_string_func;
  418. } GDExtensionCallableCustomInfo; // Deprecated. Use GDExtensionCallableCustomInfo2 instead.
  419. typedef struct {
  420. /* Only `call_func` and `token` are strictly required, however, `object_id` should be passed if its not a static method.
  421. *
  422. * `token` should point to an address that uniquely identifies the GDExtension (for example, the
  423. * `GDExtensionClassLibraryPtr` passed to the entry symbol function.
  424. *
  425. * `hash_func`, `equal_func`, and `less_than_func` are optional. If not provided both `call_func` and
  426. * `callable_userdata` together are used as the identity of the callable for hashing and comparison purposes.
  427. *
  428. * The hash returned by `hash_func` is cached, `hash_func` will not be called more than once per callable.
  429. *
  430. * `is_valid_func` is necessary if the validity of the callable can change before destruction.
  431. *
  432. * `free_func` is necessary if `callable_userdata` needs to be cleaned up when the callable is freed.
  433. */
  434. void *callable_userdata;
  435. void *token;
  436. GDObjectInstanceID object_id;
  437. GDExtensionCallableCustomCall call_func;
  438. GDExtensionCallableCustomIsValid is_valid_func;
  439. GDExtensionCallableCustomFree free_func;
  440. GDExtensionCallableCustomHash hash_func;
  441. GDExtensionCallableCustomEqual equal_func;
  442. GDExtensionCallableCustomLessThan less_than_func;
  443. GDExtensionCallableCustomToString to_string_func;
  444. GDExtensionCallableCustomGetArgumentCount get_argument_count_func;
  445. } GDExtensionCallableCustomInfo2;
  446. /* SCRIPT INSTANCE EXTENSION */
  447. typedef void *GDExtensionScriptInstanceDataPtr; // Pointer to custom ScriptInstance native implementation.
  448. typedef GDExtensionBool (*GDExtensionScriptInstanceSet)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
  449. typedef GDExtensionBool (*GDExtensionScriptInstanceGet)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  450. typedef const GDExtensionPropertyInfo *(*GDExtensionScriptInstanceGetPropertyList)(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
  451. typedef void (*GDExtensionScriptInstanceFreePropertyList)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list); // Deprecated. Use GDExtensionScriptInstanceFreePropertyList2 instead.
  452. typedef void (*GDExtensionScriptInstanceFreePropertyList2)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count);
  453. typedef GDExtensionBool (*GDExtensionScriptInstanceGetClassCategory)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_class_category);
  454. typedef GDExtensionVariantType (*GDExtensionScriptInstanceGetPropertyType)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
  455. typedef GDExtensionBool (*GDExtensionScriptInstanceValidateProperty)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_property);
  456. typedef GDExtensionBool (*GDExtensionScriptInstancePropertyCanRevert)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
  457. typedef GDExtensionBool (*GDExtensionScriptInstancePropertyGetRevert)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  458. typedef GDExtensionObjectPtr (*GDExtensionScriptInstanceGetOwner)(GDExtensionScriptInstanceDataPtr p_instance);
  459. typedef void (*GDExtensionScriptInstancePropertyStateAdd)(GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value, void *p_userdata);
  460. typedef void (*GDExtensionScriptInstanceGetPropertyState)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata);
  461. typedef const GDExtensionMethodInfo *(*GDExtensionScriptInstanceGetMethodList)(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
  462. typedef void (*GDExtensionScriptInstanceFreeMethodList)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list); // Deprecated. Use GDExtensionScriptInstanceFreeMethodList2 instead.
  463. typedef void (*GDExtensionScriptInstanceFreeMethodList2)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list, uint32_t p_count);
  464. typedef GDExtensionBool (*GDExtensionScriptInstanceHasMethod)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
  465. typedef GDExtensionInt (*GDExtensionScriptInstanceGetMethodArgumentCount)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
  466. typedef void (*GDExtensionScriptInstanceCall)(GDExtensionScriptInstanceDataPtr p_self, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
  467. typedef void (*GDExtensionScriptInstanceNotification)(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what); // Deprecated. Use GDExtensionScriptInstanceNotification2 instead.
  468. typedef void (*GDExtensionScriptInstanceNotification2)(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
  469. typedef void (*GDExtensionScriptInstanceToString)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
  470. typedef void (*GDExtensionScriptInstanceRefCountIncremented)(GDExtensionScriptInstanceDataPtr p_instance);
  471. typedef GDExtensionBool (*GDExtensionScriptInstanceRefCountDecremented)(GDExtensionScriptInstanceDataPtr p_instance);
  472. typedef GDExtensionObjectPtr (*GDExtensionScriptInstanceGetScript)(GDExtensionScriptInstanceDataPtr p_instance);
  473. typedef GDExtensionBool (*GDExtensionScriptInstanceIsPlaceholder)(GDExtensionScriptInstanceDataPtr p_instance);
  474. typedef void *GDExtensionScriptLanguagePtr;
  475. typedef GDExtensionScriptLanguagePtr (*GDExtensionScriptInstanceGetLanguage)(GDExtensionScriptInstanceDataPtr p_instance);
  476. typedef void (*GDExtensionScriptInstanceFree)(GDExtensionScriptInstanceDataPtr p_instance);
  477. typedef void *GDExtensionScriptInstancePtr; // Pointer to ScriptInstance.
  478. typedef struct {
  479. GDExtensionScriptInstanceSet set_func;
  480. GDExtensionScriptInstanceGet get_func;
  481. GDExtensionScriptInstanceGetPropertyList get_property_list_func;
  482. GDExtensionScriptInstanceFreePropertyList free_property_list_func;
  483. GDExtensionScriptInstancePropertyCanRevert property_can_revert_func;
  484. GDExtensionScriptInstancePropertyGetRevert property_get_revert_func;
  485. GDExtensionScriptInstanceGetOwner get_owner_func;
  486. GDExtensionScriptInstanceGetPropertyState get_property_state_func;
  487. GDExtensionScriptInstanceGetMethodList get_method_list_func;
  488. GDExtensionScriptInstanceFreeMethodList free_method_list_func;
  489. GDExtensionScriptInstanceGetPropertyType get_property_type_func;
  490. GDExtensionScriptInstanceHasMethod has_method_func;
  491. GDExtensionScriptInstanceCall call_func;
  492. GDExtensionScriptInstanceNotification notification_func;
  493. GDExtensionScriptInstanceToString to_string_func;
  494. GDExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
  495. GDExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
  496. GDExtensionScriptInstanceGetScript get_script_func;
  497. GDExtensionScriptInstanceIsPlaceholder is_placeholder_func;
  498. GDExtensionScriptInstanceSet set_fallback_func;
  499. GDExtensionScriptInstanceGet get_fallback_func;
  500. GDExtensionScriptInstanceGetLanguage get_language_func;
  501. GDExtensionScriptInstanceFree free_func;
  502. } GDExtensionScriptInstanceInfo; // Deprecated. Use GDExtensionScriptInstanceInfo3 instead.
  503. typedef struct {
  504. GDExtensionScriptInstanceSet set_func;
  505. GDExtensionScriptInstanceGet get_func;
  506. GDExtensionScriptInstanceGetPropertyList get_property_list_func;
  507. GDExtensionScriptInstanceFreePropertyList free_property_list_func;
  508. GDExtensionScriptInstanceGetClassCategory get_class_category_func; // Optional. Set to NULL for the default behavior.
  509. GDExtensionScriptInstancePropertyCanRevert property_can_revert_func;
  510. GDExtensionScriptInstancePropertyGetRevert property_get_revert_func;
  511. GDExtensionScriptInstanceGetOwner get_owner_func;
  512. GDExtensionScriptInstanceGetPropertyState get_property_state_func;
  513. GDExtensionScriptInstanceGetMethodList get_method_list_func;
  514. GDExtensionScriptInstanceFreeMethodList free_method_list_func;
  515. GDExtensionScriptInstanceGetPropertyType get_property_type_func;
  516. GDExtensionScriptInstanceValidateProperty validate_property_func;
  517. GDExtensionScriptInstanceHasMethod has_method_func;
  518. GDExtensionScriptInstanceCall call_func;
  519. GDExtensionScriptInstanceNotification2 notification_func;
  520. GDExtensionScriptInstanceToString to_string_func;
  521. GDExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
  522. GDExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
  523. GDExtensionScriptInstanceGetScript get_script_func;
  524. GDExtensionScriptInstanceIsPlaceholder is_placeholder_func;
  525. GDExtensionScriptInstanceSet set_fallback_func;
  526. GDExtensionScriptInstanceGet get_fallback_func;
  527. GDExtensionScriptInstanceGetLanguage get_language_func;
  528. GDExtensionScriptInstanceFree free_func;
  529. } GDExtensionScriptInstanceInfo2; // Deprecated. Use GDExtensionScriptInstanceInfo3 instead.
  530. typedef struct {
  531. GDExtensionScriptInstanceSet set_func;
  532. GDExtensionScriptInstanceGet get_func;
  533. GDExtensionScriptInstanceGetPropertyList get_property_list_func;
  534. GDExtensionScriptInstanceFreePropertyList2 free_property_list_func;
  535. GDExtensionScriptInstanceGetClassCategory get_class_category_func; // Optional. Set to NULL for the default behavior.
  536. GDExtensionScriptInstancePropertyCanRevert property_can_revert_func;
  537. GDExtensionScriptInstancePropertyGetRevert property_get_revert_func;
  538. GDExtensionScriptInstanceGetOwner get_owner_func;
  539. GDExtensionScriptInstanceGetPropertyState get_property_state_func;
  540. GDExtensionScriptInstanceGetMethodList get_method_list_func;
  541. GDExtensionScriptInstanceFreeMethodList2 free_method_list_func;
  542. GDExtensionScriptInstanceGetPropertyType get_property_type_func;
  543. GDExtensionScriptInstanceValidateProperty validate_property_func;
  544. GDExtensionScriptInstanceHasMethod has_method_func;
  545. GDExtensionScriptInstanceGetMethodArgumentCount get_method_argument_count_func;
  546. GDExtensionScriptInstanceCall call_func;
  547. GDExtensionScriptInstanceNotification2 notification_func;
  548. GDExtensionScriptInstanceToString to_string_func;
  549. GDExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
  550. GDExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
  551. GDExtensionScriptInstanceGetScript get_script_func;
  552. GDExtensionScriptInstanceIsPlaceholder is_placeholder_func;
  553. GDExtensionScriptInstanceSet set_fallback_func;
  554. GDExtensionScriptInstanceGet get_fallback_func;
  555. GDExtensionScriptInstanceGetLanguage get_language_func;
  556. GDExtensionScriptInstanceFree free_func;
  557. } GDExtensionScriptInstanceInfo3;
  558. /* INITIALIZATION */
  559. typedef enum {
  560. GDEXTENSION_INITIALIZATION_CORE,
  561. GDEXTENSION_INITIALIZATION_SERVERS,
  562. GDEXTENSION_INITIALIZATION_SCENE,
  563. GDEXTENSION_INITIALIZATION_EDITOR,
  564. GDEXTENSION_MAX_INITIALIZATION_LEVEL,
  565. } GDExtensionInitializationLevel;
  566. typedef struct {
  567. /* Minimum initialization level required.
  568. * If Core or Servers, the extension needs editor or game restart to take effect */
  569. GDExtensionInitializationLevel minimum_initialization_level;
  570. /* Up to the user to supply when initializing */
  571. void *userdata;
  572. /* This function will be called multiple times for each initialization level. */
  573. void (*initialize)(void *userdata, GDExtensionInitializationLevel p_level);
  574. void (*deinitialize)(void *userdata, GDExtensionInitializationLevel p_level);
  575. } GDExtensionInitialization;
  576. typedef void (*GDExtensionInterfaceFunctionPtr)();
  577. typedef GDExtensionInterfaceFunctionPtr (*GDExtensionInterfaceGetProcAddress)(const char *p_function_name);
  578. /*
  579. * Each GDExtension should define a C function that matches the signature of GDExtensionInitializationFunction,
  580. * and export it so that it can be loaded via dlopen() or equivalent for the given platform.
  581. *
  582. * For example:
  583. *
  584. * GDExtensionBool my_extension_init(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);
  585. *
  586. * This function's name must be specified as the 'entry_symbol' in the .gdextension file.
  587. *
  588. * This makes it the entry point of the GDExtension and will be called on initialization.
  589. *
  590. * The GDExtension can then modify the r_initialization structure, setting the minimum initialization level,
  591. * and providing pointers to functions that will be called at various stages of initialization/shutdown.
  592. *
  593. * The rest of the GDExtension's interface to Godot consists of function pointers that can be loaded
  594. * by calling p_get_proc_address("...") with the name of the function.
  595. *
  596. * For example:
  597. *
  598. * GDExtensionInterfaceGetGodotVersion get_godot_version = (GDExtensionInterfaceGetGodotVersion)p_get_proc_address("get_godot_version");
  599. *
  600. * (Note that snippet may cause "cast between incompatible function types" on some compilers, you can
  601. * silence this by adding an intermediary `void*` cast.)
  602. *
  603. * You can then call it like a normal function:
  604. *
  605. * GDExtensionGodotVersion godot_version;
  606. * get_godot_version(&godot_version);
  607. * printf("Godot v%d.%d.%d\n", godot_version.major, godot_version.minor, godot_version.patch);
  608. *
  609. * All of these interface functions are described below, together with the name that's used to load it,
  610. * and the function pointer typedef that shows its signature.
  611. */
  612. typedef GDExtensionBool (*GDExtensionInitializationFunction)(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);
  613. /* INTERFACE */
  614. typedef struct {
  615. uint32_t major;
  616. uint32_t minor;
  617. uint32_t patch;
  618. const char *string;
  619. } GDExtensionGodotVersion;
  620. /**
  621. * @name get_godot_version
  622. * @since 4.1
  623. *
  624. * Gets the Godot version that the GDExtension was loaded into.
  625. *
  626. * @param r_godot_version A pointer to the structure to write the version information into.
  627. */
  628. typedef void (*GDExtensionInterfaceGetGodotVersion)(GDExtensionGodotVersion *r_godot_version);
  629. /* INTERFACE: Memory */
  630. /**
  631. * @name mem_alloc
  632. * @since 4.1
  633. *
  634. * Allocates memory.
  635. *
  636. * @param p_bytes The amount of memory to allocate in bytes.
  637. *
  638. * @return A pointer to the allocated memory, or NULL if unsuccessful.
  639. */
  640. typedef void *(*GDExtensionInterfaceMemAlloc)(size_t p_bytes);
  641. /**
  642. * @name mem_realloc
  643. * @since 4.1
  644. *
  645. * Reallocates memory.
  646. *
  647. * @param p_ptr A pointer to the previously allocated memory.
  648. * @param p_bytes The number of bytes to resize the memory block to.
  649. *
  650. * @return A pointer to the allocated memory, or NULL if unsuccessful.
  651. */
  652. typedef void *(*GDExtensionInterfaceMemRealloc)(void *p_ptr, size_t p_bytes);
  653. /**
  654. * @name mem_free
  655. * @since 4.1
  656. *
  657. * Frees memory.
  658. *
  659. * @param p_ptr A pointer to the previously allocated memory.
  660. */
  661. typedef void (*GDExtensionInterfaceMemFree)(void *p_ptr);
  662. /* INTERFACE: Godot Core */
  663. /**
  664. * @name print_error
  665. * @since 4.1
  666. *
  667. * Logs an error to Godot's built-in debugger and to the OS terminal.
  668. *
  669. * @param p_description The code trigging the error.
  670. * @param p_function The function name where the error occurred.
  671. * @param p_file The file where the error occurred.
  672. * @param p_line The line where the error occurred.
  673. * @param p_editor_notify Whether or not to notify the editor.
  674. */
  675. typedef void (*GDExtensionInterfacePrintError)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  676. /**
  677. * @name print_error_with_message
  678. * @since 4.1
  679. *
  680. * Logs an error with a message to Godot's built-in debugger and to the OS terminal.
  681. *
  682. * @param p_description The code trigging the error.
  683. * @param p_message The message to show along with the error.
  684. * @param p_function The function name where the error occurred.
  685. * @param p_file The file where the error occurred.
  686. * @param p_line The line where the error occurred.
  687. * @param p_editor_notify Whether or not to notify the editor.
  688. */
  689. typedef void (*GDExtensionInterfacePrintErrorWithMessage)(const char *p_description, const char *p_message, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  690. /**
  691. * @name print_warning
  692. * @since 4.1
  693. *
  694. * Logs a warning to Godot's built-in debugger and to the OS terminal.
  695. *
  696. * @param p_description The code trigging the warning.
  697. * @param p_function The function name where the warning occurred.
  698. * @param p_file The file where the warning occurred.
  699. * @param p_line The line where the warning occurred.
  700. * @param p_editor_notify Whether or not to notify the editor.
  701. */
  702. typedef void (*GDExtensionInterfacePrintWarning)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  703. /**
  704. * @name print_warning_with_message
  705. * @since 4.1
  706. *
  707. * Logs a warning with a message to Godot's built-in debugger and to the OS terminal.
  708. *
  709. * @param p_description The code trigging the warning.
  710. * @param p_message The message to show along with the warning.
  711. * @param p_function The function name where the warning occurred.
  712. * @param p_file The file where the warning occurred.
  713. * @param p_line The line where the warning occurred.
  714. * @param p_editor_notify Whether or not to notify the editor.
  715. */
  716. typedef void (*GDExtensionInterfacePrintWarningWithMessage)(const char *p_description, const char *p_message, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  717. /**
  718. * @name print_script_error
  719. * @since 4.1
  720. *
  721. * Logs a script error to Godot's built-in debugger and to the OS terminal.
  722. *
  723. * @param p_description The code trigging the error.
  724. * @param p_function The function name where the error occurred.
  725. * @param p_file The file where the error occurred.
  726. * @param p_line The line where the error occurred.
  727. * @param p_editor_notify Whether or not to notify the editor.
  728. */
  729. typedef void (*GDExtensionInterfacePrintScriptError)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  730. /**
  731. * @name print_script_error_with_message
  732. * @since 4.1
  733. *
  734. * Logs a script error with a message to Godot's built-in debugger and to the OS terminal.
  735. *
  736. * @param p_description The code trigging the error.
  737. * @param p_message The message to show along with the error.
  738. * @param p_function The function name where the error occurred.
  739. * @param p_file The file where the error occurred.
  740. * @param p_line The line where the error occurred.
  741. * @param p_editor_notify Whether or not to notify the editor.
  742. */
  743. typedef void (*GDExtensionInterfacePrintScriptErrorWithMessage)(const char *p_description, const char *p_message, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  744. /**
  745. * @name get_native_struct_size
  746. * @since 4.1
  747. *
  748. * Gets the size of a native struct (ex. ObjectID) in bytes.
  749. *
  750. * @param p_name A pointer to a StringName identifying the struct name.
  751. *
  752. * @return The size in bytes.
  753. */
  754. typedef uint64_t (*GDExtensionInterfaceGetNativeStructSize)(GDExtensionConstStringNamePtr p_name);
  755. /* INTERFACE: Variant */
  756. /**
  757. * @name variant_new_copy
  758. * @since 4.1
  759. *
  760. * Copies one Variant into a another.
  761. *
  762. * @param r_dest A pointer to the destination Variant.
  763. * @param p_src A pointer to the source Variant.
  764. */
  765. typedef void (*GDExtensionInterfaceVariantNewCopy)(GDExtensionUninitializedVariantPtr r_dest, GDExtensionConstVariantPtr p_src);
  766. /**
  767. * @name variant_new_nil
  768. * @since 4.1
  769. *
  770. * Creates a new Variant containing nil.
  771. *
  772. * @param r_dest A pointer to the destination Variant.
  773. */
  774. typedef void (*GDExtensionInterfaceVariantNewNil)(GDExtensionUninitializedVariantPtr r_dest);
  775. /**
  776. * @name variant_destroy
  777. * @since 4.1
  778. *
  779. * Destroys a Variant.
  780. *
  781. * @param p_self A pointer to the Variant to destroy.
  782. */
  783. typedef void (*GDExtensionInterfaceVariantDestroy)(GDExtensionVariantPtr p_self);
  784. /**
  785. * @name variant_call
  786. * @since 4.1
  787. *
  788. * Calls a method on a Variant.
  789. *
  790. * @param p_self A pointer to the Variant.
  791. * @param p_method A pointer to a StringName identifying the method.
  792. * @param p_args A pointer to a C array of Variant.
  793. * @param p_argument_count The number of arguments.
  794. * @param r_return A pointer a Variant which will be assigned the return value.
  795. * @param r_error A pointer the structure which will hold error information.
  796. *
  797. * @see Variant::callp()
  798. */
  799. typedef void (*GDExtensionInterfaceVariantCall)(GDExtensionVariantPtr p_self, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionUninitializedVariantPtr r_return, GDExtensionCallError *r_error);
  800. /**
  801. * @name variant_call_static
  802. * @since 4.1
  803. *
  804. * Calls a static method on a Variant.
  805. *
  806. * @param p_self A pointer to the Variant.
  807. * @param p_method A pointer to a StringName identifying the method.
  808. * @param p_args A pointer to a C array of Variant.
  809. * @param p_argument_count The number of arguments.
  810. * @param r_return A pointer a Variant which will be assigned the return value.
  811. * @param r_error A pointer the structure which will be updated with error information.
  812. *
  813. * @see Variant::call_static()
  814. */
  815. typedef void (*GDExtensionInterfaceVariantCallStatic)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionUninitializedVariantPtr r_return, GDExtensionCallError *r_error);
  816. /**
  817. * @name variant_evaluate
  818. * @since 4.1
  819. *
  820. * Evaluate an operator on two Variants.
  821. *
  822. * @param p_op The operator to evaluate.
  823. * @param p_a The first Variant.
  824. * @param p_b The second Variant.
  825. * @param r_return A pointer a Variant which will be assigned the return value.
  826. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  827. *
  828. * @see Variant::evaluate()
  829. */
  830. typedef void (*GDExtensionInterfaceVariantEvaluate)(GDExtensionVariantOperator p_op, GDExtensionConstVariantPtr p_a, GDExtensionConstVariantPtr p_b, GDExtensionUninitializedVariantPtr r_return, GDExtensionBool *r_valid);
  831. /**
  832. * @name variant_set
  833. * @since 4.1
  834. *
  835. * Sets a key on a Variant to a value.
  836. *
  837. * @param p_self A pointer to the Variant.
  838. * @param p_key A pointer to a Variant representing the key.
  839. * @param p_value A pointer to a Variant representing the value.
  840. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  841. *
  842. * @see Variant::set()
  843. */
  844. typedef void (*GDExtensionInterfaceVariantSet)(GDExtensionVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid);
  845. /**
  846. * @name variant_set_named
  847. * @since 4.1
  848. *
  849. * Sets a named key on a Variant to a value.
  850. *
  851. * @param p_self A pointer to the Variant.
  852. * @param p_key A pointer to a StringName representing the key.
  853. * @param p_value A pointer to a Variant representing the value.
  854. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  855. *
  856. * @see Variant::set_named()
  857. */
  858. typedef void (*GDExtensionInterfaceVariantSetNamed)(GDExtensionVariantPtr p_self, GDExtensionConstStringNamePtr p_key, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid);
  859. /**
  860. * @name variant_set_keyed
  861. * @since 4.1
  862. *
  863. * Sets a keyed property on a Variant to a value.
  864. *
  865. * @param p_self A pointer to the Variant.
  866. * @param p_key A pointer to a Variant representing the key.
  867. * @param p_value A pointer to a Variant representing the value.
  868. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  869. *
  870. * @see Variant::set_keyed()
  871. */
  872. typedef void (*GDExtensionInterfaceVariantSetKeyed)(GDExtensionVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid);
  873. /**
  874. * @name variant_set_indexed
  875. * @since 4.1
  876. *
  877. * Sets an index on a Variant to a value.
  878. *
  879. * @param p_self A pointer to the Variant.
  880. * @param p_index The index.
  881. * @param p_value A pointer to a Variant representing the value.
  882. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  883. * @param r_oob A pointer to a boolean which will be set to true if the index is out of bounds.
  884. */
  885. typedef void (*GDExtensionInterfaceVariantSetIndexed)(GDExtensionVariantPtr p_self, GDExtensionInt p_index, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid, GDExtensionBool *r_oob);
  886. /**
  887. * @name variant_get
  888. * @since 4.1
  889. *
  890. * Gets the value of a key from a Variant.
  891. *
  892. * @param p_self A pointer to the Variant.
  893. * @param p_key A pointer to a Variant representing the key.
  894. * @param r_ret A pointer to a Variant which will be assigned the value.
  895. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  896. */
  897. typedef void (*GDExtensionInterfaceVariantGet)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  898. /**
  899. * @name variant_get_named
  900. * @since 4.1
  901. *
  902. * Gets the value of a named key from a Variant.
  903. *
  904. * @param p_self A pointer to the Variant.
  905. * @param p_key A pointer to a StringName representing the key.
  906. * @param r_ret A pointer to a Variant which will be assigned the value.
  907. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  908. */
  909. typedef void (*GDExtensionInterfaceVariantGetNamed)(GDExtensionConstVariantPtr p_self, GDExtensionConstStringNamePtr p_key, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  910. /**
  911. * @name variant_get_keyed
  912. * @since 4.1
  913. *
  914. * Gets the value of a keyed property from a Variant.
  915. *
  916. * @param p_self A pointer to the Variant.
  917. * @param p_key A pointer to a Variant representing the key.
  918. * @param r_ret A pointer to a Variant which will be assigned the value.
  919. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  920. */
  921. typedef void (*GDExtensionInterfaceVariantGetKeyed)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  922. /**
  923. * @name variant_get_indexed
  924. * @since 4.1
  925. *
  926. * Gets the value of an index from a Variant.
  927. *
  928. * @param p_self A pointer to the Variant.
  929. * @param p_index The index.
  930. * @param r_ret A pointer to a Variant which will be assigned the value.
  931. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  932. * @param r_oob A pointer to a boolean which will be set to true if the index is out of bounds.
  933. */
  934. typedef void (*GDExtensionInterfaceVariantGetIndexed)(GDExtensionConstVariantPtr p_self, GDExtensionInt p_index, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid, GDExtensionBool *r_oob);
  935. /**
  936. * @name variant_iter_init
  937. * @since 4.1
  938. *
  939. * Initializes an iterator over a Variant.
  940. *
  941. * @param p_self A pointer to the Variant.
  942. * @param r_iter A pointer to a Variant which will be assigned the iterator.
  943. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  944. *
  945. * @return true if the operation is valid; otherwise false.
  946. *
  947. * @see Variant::iter_init()
  948. */
  949. typedef GDExtensionBool (*GDExtensionInterfaceVariantIterInit)(GDExtensionConstVariantPtr p_self, GDExtensionUninitializedVariantPtr r_iter, GDExtensionBool *r_valid);
  950. /**
  951. * @name variant_iter_next
  952. * @since 4.1
  953. *
  954. * Gets the next value for an iterator over a Variant.
  955. *
  956. * @param p_self A pointer to the Variant.
  957. * @param r_iter A pointer to a Variant which will be assigned the iterator.
  958. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  959. *
  960. * @return true if the operation is valid; otherwise false.
  961. *
  962. * @see Variant::iter_next()
  963. */
  964. typedef GDExtensionBool (*GDExtensionInterfaceVariantIterNext)(GDExtensionConstVariantPtr p_self, GDExtensionVariantPtr r_iter, GDExtensionBool *r_valid);
  965. /**
  966. * @name variant_iter_get
  967. * @since 4.1
  968. *
  969. * Gets the next value for an iterator over a Variant.
  970. *
  971. * @param p_self A pointer to the Variant.
  972. * @param r_iter A pointer to a Variant which will be assigned the iterator.
  973. * @param r_ret A pointer to a Variant which will be assigned false if the operation is invalid.
  974. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  975. *
  976. * @see Variant::iter_get()
  977. */
  978. typedef void (*GDExtensionInterfaceVariantIterGet)(GDExtensionConstVariantPtr p_self, GDExtensionVariantPtr r_iter, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  979. /**
  980. * @name variant_hash
  981. * @since 4.1
  982. *
  983. * Gets the hash of a Variant.
  984. *
  985. * @param p_self A pointer to the Variant.
  986. *
  987. * @return The hash value.
  988. *
  989. * @see Variant::hash()
  990. */
  991. typedef GDExtensionInt (*GDExtensionInterfaceVariantHash)(GDExtensionConstVariantPtr p_self);
  992. /**
  993. * @name variant_recursive_hash
  994. * @since 4.1
  995. *
  996. * Gets the recursive hash of a Variant.
  997. *
  998. * @param p_self A pointer to the Variant.
  999. * @param p_recursion_count The number of recursive loops so far.
  1000. *
  1001. * @return The hash value.
  1002. *
  1003. * @see Variant::recursive_hash()
  1004. */
  1005. typedef GDExtensionInt (*GDExtensionInterfaceVariantRecursiveHash)(GDExtensionConstVariantPtr p_self, GDExtensionInt p_recursion_count);
  1006. /**
  1007. * @name variant_hash_compare
  1008. * @since 4.1
  1009. *
  1010. * Compares two Variants by their hash.
  1011. *
  1012. * @param p_self A pointer to the Variant.
  1013. * @param p_other A pointer to the other Variant to compare it to.
  1014. *
  1015. * @return The hash value.
  1016. *
  1017. * @see Variant::hash_compare()
  1018. */
  1019. typedef GDExtensionBool (*GDExtensionInterfaceVariantHashCompare)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_other);
  1020. /**
  1021. * @name variant_booleanize
  1022. * @since 4.1
  1023. *
  1024. * Converts a Variant to a boolean.
  1025. *
  1026. * @param p_self A pointer to the Variant.
  1027. *
  1028. * @return The boolean value of the Variant.
  1029. */
  1030. typedef GDExtensionBool (*GDExtensionInterfaceVariantBooleanize)(GDExtensionConstVariantPtr p_self);
  1031. /**
  1032. * @name variant_duplicate
  1033. * @since 4.1
  1034. *
  1035. * Duplicates a Variant.
  1036. *
  1037. * @param p_self A pointer to the Variant.
  1038. * @param r_ret A pointer to a Variant to store the duplicated value.
  1039. * @param p_deep Whether or not to duplicate deeply (when supported by the Variant type).
  1040. */
  1041. typedef void (*GDExtensionInterfaceVariantDuplicate)(GDExtensionConstVariantPtr p_self, GDExtensionVariantPtr r_ret, GDExtensionBool p_deep);
  1042. /**
  1043. * @name variant_stringify
  1044. * @since 4.1
  1045. *
  1046. * Converts a Variant to a string.
  1047. *
  1048. * @param p_self A pointer to the Variant.
  1049. * @param r_ret A pointer to a String to store the resulting value.
  1050. */
  1051. typedef void (*GDExtensionInterfaceVariantStringify)(GDExtensionConstVariantPtr p_self, GDExtensionStringPtr r_ret);
  1052. /**
  1053. * @name variant_get_type
  1054. * @since 4.1
  1055. *
  1056. * Gets the type of a Variant.
  1057. *
  1058. * @param p_self A pointer to the Variant.
  1059. *
  1060. * @return The variant type.
  1061. */
  1062. typedef GDExtensionVariantType (*GDExtensionInterfaceVariantGetType)(GDExtensionConstVariantPtr p_self);
  1063. /**
  1064. * @name variant_has_method
  1065. * @since 4.1
  1066. *
  1067. * Checks if a Variant has the given method.
  1068. *
  1069. * @param p_self A pointer to the Variant.
  1070. * @param p_method A pointer to a StringName with the method name.
  1071. *
  1072. * @return
  1073. */
  1074. typedef GDExtensionBool (*GDExtensionInterfaceVariantHasMethod)(GDExtensionConstVariantPtr p_self, GDExtensionConstStringNamePtr p_method);
  1075. /**
  1076. * @name variant_has_member
  1077. * @since 4.1
  1078. *
  1079. * Checks if a type of Variant has the given member.
  1080. *
  1081. * @param p_type The Variant type.
  1082. * @param p_member A pointer to a StringName with the member name.
  1083. *
  1084. * @return
  1085. */
  1086. typedef GDExtensionBool (*GDExtensionInterfaceVariantHasMember)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_member);
  1087. /**
  1088. * @name variant_has_key
  1089. * @since 4.1
  1090. *
  1091. * Checks if a Variant has a key.
  1092. *
  1093. * @param p_self A pointer to the Variant.
  1094. * @param p_key A pointer to a Variant representing the key.
  1095. * @param r_valid A pointer to a boolean which will be set to false if the key doesn't exist.
  1096. *
  1097. * @return true if the key exists; otherwise false.
  1098. */
  1099. typedef GDExtensionBool (*GDExtensionInterfaceVariantHasKey)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionBool *r_valid);
  1100. /**
  1101. * @name variant_get_type_name
  1102. * @since 4.1
  1103. *
  1104. * Gets the name of a Variant type.
  1105. *
  1106. * @param p_type The Variant type.
  1107. * @param r_name A pointer to a String to store the Variant type name.
  1108. */
  1109. typedef void (*GDExtensionInterfaceVariantGetTypeName)(GDExtensionVariantType p_type, GDExtensionUninitializedStringPtr r_name);
  1110. /**
  1111. * @name variant_can_convert
  1112. * @since 4.1
  1113. *
  1114. * Checks if Variants can be converted from one type to another.
  1115. *
  1116. * @param p_from The Variant type to convert from.
  1117. * @param p_to The Variant type to convert to.
  1118. *
  1119. * @return true if the conversion is possible; otherwise false.
  1120. */
  1121. typedef GDExtensionBool (*GDExtensionInterfaceVariantCanConvert)(GDExtensionVariantType p_from, GDExtensionVariantType p_to);
  1122. /**
  1123. * @name variant_can_convert_strict
  1124. * @since 4.1
  1125. *
  1126. * Checks if Variant can be converted from one type to another using stricter rules.
  1127. *
  1128. * @param p_from The Variant type to convert from.
  1129. * @param p_to The Variant type to convert to.
  1130. *
  1131. * @return true if the conversion is possible; otherwise false.
  1132. */
  1133. typedef GDExtensionBool (*GDExtensionInterfaceVariantCanConvertStrict)(GDExtensionVariantType p_from, GDExtensionVariantType p_to);
  1134. /**
  1135. * @name get_variant_from_type_constructor
  1136. * @since 4.1
  1137. *
  1138. * Gets a pointer to a function that can create a Variant of the given type from a raw value.
  1139. *
  1140. * @param p_type The Variant type.
  1141. *
  1142. * @return A pointer to a function that can create a Variant of the given type from a raw value.
  1143. */
  1144. typedef GDExtensionVariantFromTypeConstructorFunc (*GDExtensionInterfaceGetVariantFromTypeConstructor)(GDExtensionVariantType p_type);
  1145. /**
  1146. * @name get_variant_to_type_constructor
  1147. * @since 4.1
  1148. *
  1149. * Gets a pointer to a function that can get the raw value from a Variant of the given type.
  1150. *
  1151. * @param p_type The Variant type.
  1152. *
  1153. * @return A pointer to a function that can get the raw value from a Variant of the given type.
  1154. */
  1155. typedef GDExtensionTypeFromVariantConstructorFunc (*GDExtensionInterfaceGetVariantToTypeConstructor)(GDExtensionVariantType p_type);
  1156. /**
  1157. * @name variant_get_ptr_operator_evaluator
  1158. * @since 4.1
  1159. *
  1160. * Gets a pointer to a function that can evaluate the given Variant operator on the given Variant types.
  1161. *
  1162. * @param p_operator The variant operator.
  1163. * @param p_type_a The type of the first Variant.
  1164. * @param p_type_b The type of the second Variant.
  1165. *
  1166. * @return A pointer to a function that can evaluate the given Variant operator on the given Variant types.
  1167. */
  1168. typedef GDExtensionPtrOperatorEvaluator (*GDExtensionInterfaceVariantGetPtrOperatorEvaluator)(GDExtensionVariantOperator p_operator, GDExtensionVariantType p_type_a, GDExtensionVariantType p_type_b);
  1169. /**
  1170. * @name variant_get_ptr_builtin_method
  1171. * @since 4.1
  1172. *
  1173. * Gets a pointer to a function that can call a builtin method on a type of Variant.
  1174. *
  1175. * @param p_type The Variant type.
  1176. * @param p_method A pointer to a StringName with the method name.
  1177. * @param p_hash A hash representing the method signature.
  1178. *
  1179. * @return A pointer to a function that can call a builtin method on a type of Variant.
  1180. */
  1181. typedef GDExtensionPtrBuiltInMethod (*GDExtensionInterfaceVariantGetPtrBuiltinMethod)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_method, GDExtensionInt p_hash);
  1182. /**
  1183. * @name variant_get_ptr_constructor
  1184. * @since 4.1
  1185. *
  1186. * Gets a pointer to a function that can call one of the constructors for a type of Variant.
  1187. *
  1188. * @param p_type The Variant type.
  1189. * @param p_constructor The index of the constructor.
  1190. *
  1191. * @return A pointer to a function that can call one of the constructors for a type of Variant.
  1192. */
  1193. typedef GDExtensionPtrConstructor (*GDExtensionInterfaceVariantGetPtrConstructor)(GDExtensionVariantType p_type, int32_t p_constructor);
  1194. /**
  1195. * @name variant_get_ptr_destructor
  1196. * @since 4.1
  1197. *
  1198. * Gets a pointer to a function than can call the destructor for a type of Variant.
  1199. *
  1200. * @param p_type The Variant type.
  1201. *
  1202. * @return A pointer to a function than can call the destructor for a type of Variant.
  1203. */
  1204. typedef GDExtensionPtrDestructor (*GDExtensionInterfaceVariantGetPtrDestructor)(GDExtensionVariantType p_type);
  1205. /**
  1206. * @name variant_construct
  1207. * @since 4.1
  1208. *
  1209. * Constructs a Variant of the given type, using the first constructor that matches the given arguments.
  1210. *
  1211. * @param p_type The Variant type.
  1212. * @param p_base A pointer to a Variant to store the constructed value.
  1213. * @param p_args A pointer to a C array of Variant pointers representing the arguments for the constructor.
  1214. * @param p_argument_count The number of arguments to pass to the constructor.
  1215. * @param r_error A pointer the structure which will be updated with error information.
  1216. */
  1217. typedef void (*GDExtensionInterfaceVariantConstruct)(GDExtensionVariantType p_type, GDExtensionUninitializedVariantPtr r_base, const GDExtensionConstVariantPtr *p_args, int32_t p_argument_count, GDExtensionCallError *r_error);
  1218. /**
  1219. * @name variant_get_ptr_setter
  1220. * @since 4.1
  1221. *
  1222. * Gets a pointer to a function that can call a member's setter on the given Variant type.
  1223. *
  1224. * @param p_type The Variant type.
  1225. * @param p_member A pointer to a StringName with the member name.
  1226. *
  1227. * @return A pointer to a function that can call a member's setter on the given Variant type.
  1228. */
  1229. typedef GDExtensionPtrSetter (*GDExtensionInterfaceVariantGetPtrSetter)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_member);
  1230. /**
  1231. * @name variant_get_ptr_getter
  1232. * @since 4.1
  1233. *
  1234. * Gets a pointer to a function that can call a member's getter on the given Variant type.
  1235. *
  1236. * @param p_type The Variant type.
  1237. * @param p_member A pointer to a StringName with the member name.
  1238. *
  1239. * @return A pointer to a function that can call a member's getter on the given Variant type.
  1240. */
  1241. typedef GDExtensionPtrGetter (*GDExtensionInterfaceVariantGetPtrGetter)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_member);
  1242. /**
  1243. * @name variant_get_ptr_indexed_setter
  1244. * @since 4.1
  1245. *
  1246. * Gets a pointer to a function that can set an index on the given Variant type.
  1247. *
  1248. * @param p_type The Variant type.
  1249. *
  1250. * @return A pointer to a function that can set an index on the given Variant type.
  1251. */
  1252. typedef GDExtensionPtrIndexedSetter (*GDExtensionInterfaceVariantGetPtrIndexedSetter)(GDExtensionVariantType p_type);
  1253. /**
  1254. * @name variant_get_ptr_indexed_getter
  1255. * @since 4.1
  1256. *
  1257. * Gets a pointer to a function that can get an index on the given Variant type.
  1258. *
  1259. * @param p_type The Variant type.
  1260. *
  1261. * @return A pointer to a function that can get an index on the given Variant type.
  1262. */
  1263. typedef GDExtensionPtrIndexedGetter (*GDExtensionInterfaceVariantGetPtrIndexedGetter)(GDExtensionVariantType p_type);
  1264. /**
  1265. * @name variant_get_ptr_keyed_setter
  1266. * @since 4.1
  1267. *
  1268. * Gets a pointer to a function that can set a key on the given Variant type.
  1269. *
  1270. * @param p_type The Variant type.
  1271. *
  1272. * @return A pointer to a function that can set a key on the given Variant type.
  1273. */
  1274. typedef GDExtensionPtrKeyedSetter (*GDExtensionInterfaceVariantGetPtrKeyedSetter)(GDExtensionVariantType p_type);
  1275. /**
  1276. * @name variant_get_ptr_keyed_getter
  1277. * @since 4.1
  1278. *
  1279. * Gets a pointer to a function that can get a key on the given Variant type.
  1280. *
  1281. * @param p_type The Variant type.
  1282. *
  1283. * @return A pointer to a function that can get a key on the given Variant type.
  1284. */
  1285. typedef GDExtensionPtrKeyedGetter (*GDExtensionInterfaceVariantGetPtrKeyedGetter)(GDExtensionVariantType p_type);
  1286. /**
  1287. * @name variant_get_ptr_keyed_checker
  1288. * @since 4.1
  1289. *
  1290. * Gets a pointer to a function that can check a key on the given Variant type.
  1291. *
  1292. * @param p_type The Variant type.
  1293. *
  1294. * @return A pointer to a function that can check a key on the given Variant type.
  1295. */
  1296. typedef GDExtensionPtrKeyedChecker (*GDExtensionInterfaceVariantGetPtrKeyedChecker)(GDExtensionVariantType p_type);
  1297. /**
  1298. * @name variant_get_constant_value
  1299. * @since 4.1
  1300. *
  1301. * Gets the value of a constant from the given Variant type.
  1302. *
  1303. * @param p_type The Variant type.
  1304. * @param p_constant A pointer to a StringName with the constant name.
  1305. * @param r_ret A pointer to a Variant to store the value.
  1306. */
  1307. typedef void (*GDExtensionInterfaceVariantGetConstantValue)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_constant, GDExtensionUninitializedVariantPtr r_ret);
  1308. /**
  1309. * @name variant_get_ptr_utility_function
  1310. * @since 4.1
  1311. *
  1312. * Gets a pointer to a function that can call a Variant utility function.
  1313. *
  1314. * @param p_function A pointer to a StringName with the function name.
  1315. * @param p_hash A hash representing the function signature.
  1316. *
  1317. * @return A pointer to a function that can call a Variant utility function.
  1318. */
  1319. typedef GDExtensionPtrUtilityFunction (*GDExtensionInterfaceVariantGetPtrUtilityFunction)(GDExtensionConstStringNamePtr p_function, GDExtensionInt p_hash);
  1320. /* INTERFACE: String Utilities */
  1321. /**
  1322. * @name string_new_with_latin1_chars
  1323. * @since 4.1
  1324. *
  1325. * Creates a String from a Latin-1 encoded C string.
  1326. *
  1327. * @param r_dest A pointer to a Variant to hold the newly created String.
  1328. * @param p_contents A pointer to a Latin-1 encoded C string (null terminated).
  1329. */
  1330. typedef void (*GDExtensionInterfaceStringNewWithLatin1Chars)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents);
  1331. /**
  1332. * @name string_new_with_utf8_chars
  1333. * @since 4.1
  1334. *
  1335. * Creates a String from a UTF-8 encoded C string.
  1336. *
  1337. * @param r_dest A pointer to a Variant to hold the newly created String.
  1338. * @param p_contents A pointer to a UTF-8 encoded C string (null terminated).
  1339. */
  1340. typedef void (*GDExtensionInterfaceStringNewWithUtf8Chars)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents);
  1341. /**
  1342. * @name string_new_with_utf16_chars
  1343. * @since 4.1
  1344. *
  1345. * Creates a String from a UTF-16 encoded C string.
  1346. *
  1347. * @param r_dest A pointer to a Variant to hold the newly created String.
  1348. * @param p_contents A pointer to a UTF-16 encoded C string (null terminated).
  1349. */
  1350. typedef void (*GDExtensionInterfaceStringNewWithUtf16Chars)(GDExtensionUninitializedStringPtr r_dest, const char16_t *p_contents);
  1351. /**
  1352. * @name string_new_with_utf32_chars
  1353. * @since 4.1
  1354. *
  1355. * Creates a String from a UTF-32 encoded C string.
  1356. *
  1357. * @param r_dest A pointer to a Variant to hold the newly created String.
  1358. * @param p_contents A pointer to a UTF-32 encoded C string (null terminated).
  1359. */
  1360. typedef void (*GDExtensionInterfaceStringNewWithUtf32Chars)(GDExtensionUninitializedStringPtr r_dest, const char32_t *p_contents);
  1361. /**
  1362. * @name string_new_with_wide_chars
  1363. * @since 4.1
  1364. *
  1365. * Creates a String from a wide C string.
  1366. *
  1367. * @param r_dest A pointer to a Variant to hold the newly created String.
  1368. * @param p_contents A pointer to a wide C string (null terminated).
  1369. */
  1370. typedef void (*GDExtensionInterfaceStringNewWithWideChars)(GDExtensionUninitializedStringPtr r_dest, const wchar_t *p_contents);
  1371. /**
  1372. * @name string_new_with_latin1_chars_and_len
  1373. * @since 4.1
  1374. *
  1375. * Creates a String from a Latin-1 encoded C string with the given length.
  1376. *
  1377. * @param r_dest A pointer to a Variant to hold the newly created String.
  1378. * @param p_contents A pointer to a Latin-1 encoded C string.
  1379. * @param p_size The number of characters (= number of bytes).
  1380. */
  1381. typedef void (*GDExtensionInterfaceStringNewWithLatin1CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1382. /**
  1383. * @name string_new_with_utf8_chars_and_len
  1384. * @since 4.1
  1385. *
  1386. * Creates a String from a UTF-8 encoded C string with the given length.
  1387. *
  1388. * @param r_dest A pointer to a Variant to hold the newly created String.
  1389. * @param p_contents A pointer to a UTF-8 encoded C string.
  1390. * @param p_size The number of bytes (not code units).
  1391. */
  1392. typedef void (*GDExtensionInterfaceStringNewWithUtf8CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1393. /**
  1394. * @name string_new_with_utf16_chars_and_len
  1395. * @since 4.1
  1396. *
  1397. * Creates a String from a UTF-16 encoded C string with the given length.
  1398. *
  1399. * @param r_dest A pointer to a Variant to hold the newly created String.
  1400. * @param p_contents A pointer to a UTF-16 encoded C string.
  1401. * @param p_size The number of characters (not bytes).
  1402. */
  1403. typedef void (*GDExtensionInterfaceStringNewWithUtf16CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char16_t *p_contents, GDExtensionInt p_char_count);
  1404. /**
  1405. * @name string_new_with_utf32_chars_and_len
  1406. * @since 4.1
  1407. *
  1408. * Creates a String from a UTF-32 encoded C string with the given length.
  1409. *
  1410. * @param r_dest A pointer to a Variant to hold the newly created String.
  1411. * @param p_contents A pointer to a UTF-32 encoded C string.
  1412. * @param p_size The number of characters (not bytes).
  1413. */
  1414. typedef void (*GDExtensionInterfaceStringNewWithUtf32CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char32_t *p_contents, GDExtensionInt p_char_count);
  1415. /**
  1416. * @name string_new_with_wide_chars_and_len
  1417. * @since 4.1
  1418. *
  1419. * Creates a String from a wide C string with the given length.
  1420. *
  1421. * @param r_dest A pointer to a Variant to hold the newly created String.
  1422. * @param p_contents A pointer to a wide C string.
  1423. * @param p_size The number of characters (not bytes).
  1424. */
  1425. typedef void (*GDExtensionInterfaceStringNewWithWideCharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const wchar_t *p_contents, GDExtensionInt p_char_count);
  1426. /**
  1427. * @name string_to_latin1_chars
  1428. * @since 4.1
  1429. *
  1430. * Converts a String to a Latin-1 encoded C string.
  1431. *
  1432. * It doesn't write a null terminator.
  1433. *
  1434. * @param p_self A pointer to the String.
  1435. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1436. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1437. *
  1438. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1439. */
  1440. typedef GDExtensionInt (*GDExtensionInterfaceStringToLatin1Chars)(GDExtensionConstStringPtr p_self, char *r_text, GDExtensionInt p_max_write_length);
  1441. /**
  1442. * @name string_to_utf8_chars
  1443. * @since 4.1
  1444. *
  1445. * Converts a String to a UTF-8 encoded C string.
  1446. *
  1447. * It doesn't write a null terminator.
  1448. *
  1449. * @param p_self A pointer to the String.
  1450. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1451. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1452. *
  1453. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1454. */
  1455. typedef GDExtensionInt (*GDExtensionInterfaceStringToUtf8Chars)(GDExtensionConstStringPtr p_self, char *r_text, GDExtensionInt p_max_write_length);
  1456. /**
  1457. * @name string_to_utf16_chars
  1458. * @since 4.1
  1459. *
  1460. * Converts a String to a UTF-16 encoded C string.
  1461. *
  1462. * It doesn't write a null terminator.
  1463. *
  1464. * @param p_self A pointer to the String.
  1465. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1466. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1467. *
  1468. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1469. */
  1470. typedef GDExtensionInt (*GDExtensionInterfaceStringToUtf16Chars)(GDExtensionConstStringPtr p_self, char16_t *r_text, GDExtensionInt p_max_write_length);
  1471. /**
  1472. * @name string_to_utf32_chars
  1473. * @since 4.1
  1474. *
  1475. * Converts a String to a UTF-32 encoded C string.
  1476. *
  1477. * It doesn't write a null terminator.
  1478. *
  1479. * @param p_self A pointer to the String.
  1480. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1481. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1482. *
  1483. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1484. */
  1485. typedef GDExtensionInt (*GDExtensionInterfaceStringToUtf32Chars)(GDExtensionConstStringPtr p_self, char32_t *r_text, GDExtensionInt p_max_write_length);
  1486. /**
  1487. * @name string_to_wide_chars
  1488. * @since 4.1
  1489. *
  1490. * Converts a String to a wide C string.
  1491. *
  1492. * It doesn't write a null terminator.
  1493. *
  1494. * @param p_self A pointer to the String.
  1495. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1496. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1497. *
  1498. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1499. */
  1500. typedef GDExtensionInt (*GDExtensionInterfaceStringToWideChars)(GDExtensionConstStringPtr p_self, wchar_t *r_text, GDExtensionInt p_max_write_length);
  1501. /**
  1502. * @name string_operator_index
  1503. * @since 4.1
  1504. *
  1505. * Gets a pointer to the character at the given index from a String.
  1506. *
  1507. * @param p_self A pointer to the String.
  1508. * @param p_index The index.
  1509. *
  1510. * @return A pointer to the requested character.
  1511. */
  1512. typedef char32_t *(*GDExtensionInterfaceStringOperatorIndex)(GDExtensionStringPtr p_self, GDExtensionInt p_index);
  1513. /**
  1514. * @name string_operator_index_const
  1515. * @since 4.1
  1516. *
  1517. * Gets a const pointer to the character at the given index from a String.
  1518. *
  1519. * @param p_self A pointer to the String.
  1520. * @param p_index The index.
  1521. *
  1522. * @return A const pointer to the requested character.
  1523. */
  1524. typedef const char32_t *(*GDExtensionInterfaceStringOperatorIndexConst)(GDExtensionConstStringPtr p_self, GDExtensionInt p_index);
  1525. /**
  1526. * @name string_operator_plus_eq_string
  1527. * @since 4.1
  1528. *
  1529. * Appends another String to a String.
  1530. *
  1531. * @param p_self A pointer to the String.
  1532. * @param p_b A pointer to the other String to append.
  1533. */
  1534. typedef void (*GDExtensionInterfaceStringOperatorPlusEqString)(GDExtensionStringPtr p_self, GDExtensionConstStringPtr p_b);
  1535. /**
  1536. * @name string_operator_plus_eq_char
  1537. * @since 4.1
  1538. *
  1539. * Appends a character to a String.
  1540. *
  1541. * @param p_self A pointer to the String.
  1542. * @param p_b A pointer to the character to append.
  1543. */
  1544. typedef void (*GDExtensionInterfaceStringOperatorPlusEqChar)(GDExtensionStringPtr p_self, char32_t p_b);
  1545. /**
  1546. * @name string_operator_plus_eq_cstr
  1547. * @since 4.1
  1548. *
  1549. * Appends a Latin-1 encoded C string to a String.
  1550. *
  1551. * @param p_self A pointer to the String.
  1552. * @param p_b A pointer to a Latin-1 encoded C string (null terminated).
  1553. */
  1554. typedef void (*GDExtensionInterfaceStringOperatorPlusEqCstr)(GDExtensionStringPtr p_self, const char *p_b);
  1555. /**
  1556. * @name string_operator_plus_eq_wcstr
  1557. * @since 4.1
  1558. *
  1559. * Appends a wide C string to a String.
  1560. *
  1561. * @param p_self A pointer to the String.
  1562. * @param p_b A pointer to a wide C string (null terminated).
  1563. */
  1564. typedef void (*GDExtensionInterfaceStringOperatorPlusEqWcstr)(GDExtensionStringPtr p_self, const wchar_t *p_b);
  1565. /**
  1566. * @name string_operator_plus_eq_c32str
  1567. * @since 4.1
  1568. *
  1569. * Appends a UTF-32 encoded C string to a String.
  1570. *
  1571. * @param p_self A pointer to the String.
  1572. * @param p_b A pointer to a UTF-32 encoded C string (null terminated).
  1573. */
  1574. typedef void (*GDExtensionInterfaceStringOperatorPlusEqC32str)(GDExtensionStringPtr p_self, const char32_t *p_b);
  1575. /**
  1576. * @name string_resize
  1577. * @since 4.2
  1578. *
  1579. * Resizes the underlying string data to the given number of characters.
  1580. *
  1581. * Space needs to be allocated for the null terminating character ('\0') which
  1582. * also must be added manually, in order for all string functions to work correctly.
  1583. *
  1584. * Warning: This is an error-prone operation - only use it if there's no other
  1585. * efficient way to accomplish your goal.
  1586. *
  1587. * @param p_self A pointer to the String.
  1588. * @param p_resize The new length for the String.
  1589. *
  1590. * @return Error code signifying if the operation successful.
  1591. */
  1592. typedef GDExtensionInt (*GDExtensionInterfaceStringResize)(GDExtensionStringPtr p_self, GDExtensionInt p_resize);
  1593. /* INTERFACE: StringName Utilities */
  1594. /**
  1595. * @name string_name_new_with_latin1_chars
  1596. * @since 4.2
  1597. *
  1598. * Creates a StringName from a Latin-1 encoded C string.
  1599. *
  1600. * If `p_is_static` is true, then:
  1601. * - The StringName will reuse the `p_contents` buffer instead of copying it.
  1602. * You must guarantee that the buffer remains valid for the duration of the application (e.g. string literal).
  1603. * - You must not call a destructor for this StringName. Incrementing the initial reference once should achieve this.
  1604. *
  1605. * `p_is_static` is purely an optimization and can easily introduce undefined behavior if used wrong. In case of doubt, set it to false.
  1606. *
  1607. * @param r_dest A pointer to uninitialized storage, into which the newly created StringName is constructed.
  1608. * @param p_contents A pointer to a C string (null terminated and Latin-1 or ASCII encoded).
  1609. * @param p_is_static Whether the StringName reuses the buffer directly (see above).
  1610. */
  1611. typedef void (*GDExtensionInterfaceStringNameNewWithLatin1Chars)(GDExtensionUninitializedStringNamePtr r_dest, const char *p_contents, GDExtensionBool p_is_static);
  1612. /**
  1613. * @name string_name_new_with_utf8_chars
  1614. * @since 4.2
  1615. *
  1616. * Creates a StringName from a UTF-8 encoded C string.
  1617. *
  1618. * @param r_dest A pointer to uninitialized storage, into which the newly created StringName is constructed.
  1619. * @param p_contents A pointer to a C string (null terminated and UTF-8 encoded).
  1620. */
  1621. typedef void (*GDExtensionInterfaceStringNameNewWithUtf8Chars)(GDExtensionUninitializedStringNamePtr r_dest, const char *p_contents);
  1622. /**
  1623. * @name string_name_new_with_utf8_chars_and_len
  1624. * @since 4.2
  1625. *
  1626. * Creates a StringName from a UTF-8 encoded string with a given number of characters.
  1627. *
  1628. * @param r_dest A pointer to uninitialized storage, into which the newly created StringName is constructed.
  1629. * @param p_contents A pointer to a C string (null terminated and UTF-8 encoded).
  1630. * @param p_size The number of bytes (not UTF-8 code points).
  1631. */
  1632. typedef void (*GDExtensionInterfaceStringNameNewWithUtf8CharsAndLen)(GDExtensionUninitializedStringNamePtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1633. /* INTERFACE: XMLParser Utilities */
  1634. /**
  1635. * @name xml_parser_open_buffer
  1636. * @since 4.1
  1637. *
  1638. * Opens a raw XML buffer on an XMLParser instance.
  1639. *
  1640. * @param p_instance A pointer to an XMLParser object.
  1641. * @param p_buffer A pointer to the buffer.
  1642. * @param p_size The size of the buffer.
  1643. *
  1644. * @return A Godot error code (ex. OK, ERR_INVALID_DATA, etc).
  1645. *
  1646. * @see XMLParser::open_buffer()
  1647. */
  1648. typedef GDExtensionInt (*GDExtensionInterfaceXmlParserOpenBuffer)(GDExtensionObjectPtr p_instance, const uint8_t *p_buffer, size_t p_size);
  1649. /* INTERFACE: FileAccess Utilities */
  1650. /**
  1651. * @name file_access_store_buffer
  1652. * @since 4.1
  1653. *
  1654. * Stores the given buffer using an instance of FileAccess.
  1655. *
  1656. * @param p_instance A pointer to a FileAccess object.
  1657. * @param p_src A pointer to the buffer.
  1658. * @param p_length The size of the buffer.
  1659. *
  1660. * @see FileAccess::store_buffer()
  1661. */
  1662. typedef void (*GDExtensionInterfaceFileAccessStoreBuffer)(GDExtensionObjectPtr p_instance, const uint8_t *p_src, uint64_t p_length);
  1663. /**
  1664. * @name file_access_get_buffer
  1665. * @since 4.1
  1666. *
  1667. * Reads the next p_length bytes into the given buffer using an instance of FileAccess.
  1668. *
  1669. * @param p_instance A pointer to a FileAccess object.
  1670. * @param p_dst A pointer to the buffer to store the data.
  1671. * @param p_length The requested number of bytes to read.
  1672. *
  1673. * @return The actual number of bytes read (may be less than requested).
  1674. */
  1675. typedef uint64_t (*GDExtensionInterfaceFileAccessGetBuffer)(GDExtensionConstObjectPtr p_instance, uint8_t *p_dst, uint64_t p_length);
  1676. /* INTERFACE: WorkerThreadPool Utilities */
  1677. /**
  1678. * @name worker_thread_pool_add_native_group_task
  1679. * @since 4.1
  1680. *
  1681. * Adds a group task to an instance of WorkerThreadPool.
  1682. *
  1683. * @param p_instance A pointer to a WorkerThreadPool object.
  1684. * @param p_func A pointer to a function to run in the thread pool.
  1685. * @param p_userdata A pointer to arbitrary data which will be passed to p_func.
  1686. * @param p_tasks The number of tasks needed in the group.
  1687. * @param p_high_priority Whether or not this is a high priority task.
  1688. * @param p_description A pointer to a String with the task description.
  1689. *
  1690. * @return The task group ID.
  1691. *
  1692. * @see WorkerThreadPool::add_group_task()
  1693. */
  1694. typedef int64_t (*GDExtensionInterfaceWorkerThreadPoolAddNativeGroupTask)(GDExtensionObjectPtr p_instance, void (*p_func)(void *, uint32_t), void *p_userdata, int p_elements, int p_tasks, GDExtensionBool p_high_priority, GDExtensionConstStringPtr p_description);
  1695. /**
  1696. * @name worker_thread_pool_add_native_task
  1697. * @since 4.1
  1698. *
  1699. * Adds a task to an instance of WorkerThreadPool.
  1700. *
  1701. * @param p_instance A pointer to a WorkerThreadPool object.
  1702. * @param p_func A pointer to a function to run in the thread pool.
  1703. * @param p_userdata A pointer to arbitrary data which will be passed to p_func.
  1704. * @param p_high_priority Whether or not this is a high priority task.
  1705. * @param p_description A pointer to a String with the task description.
  1706. *
  1707. * @return The task ID.
  1708. */
  1709. typedef int64_t (*GDExtensionInterfaceWorkerThreadPoolAddNativeTask)(GDExtensionObjectPtr p_instance, void (*p_func)(void *), void *p_userdata, GDExtensionBool p_high_priority, GDExtensionConstStringPtr p_description);
  1710. /* INTERFACE: Packed Array */
  1711. /**
  1712. * @name packed_byte_array_operator_index
  1713. * @since 4.1
  1714. *
  1715. * Gets a pointer to a byte in a PackedByteArray.
  1716. *
  1717. * @param p_self A pointer to a PackedByteArray object.
  1718. * @param p_index The index of the byte to get.
  1719. *
  1720. * @return A pointer to the requested byte.
  1721. */
  1722. typedef uint8_t *(*GDExtensionInterfacePackedByteArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1723. /**
  1724. * @name packed_byte_array_operator_index_const
  1725. * @since 4.1
  1726. *
  1727. * Gets a const pointer to a byte in a PackedByteArray.
  1728. *
  1729. * @param p_self A const pointer to a PackedByteArray object.
  1730. * @param p_index The index of the byte to get.
  1731. *
  1732. * @return A const pointer to the requested byte.
  1733. */
  1734. typedef const uint8_t *(*GDExtensionInterfacePackedByteArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1735. /**
  1736. * @name packed_color_array_operator_index
  1737. * @since 4.1
  1738. *
  1739. * Gets a pointer to a color in a PackedColorArray.
  1740. *
  1741. * @param p_self A pointer to a PackedColorArray object.
  1742. * @param p_index The index of the Color to get.
  1743. *
  1744. * @return A pointer to the requested Color.
  1745. */
  1746. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedColorArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1747. /**
  1748. * @name packed_color_array_operator_index_const
  1749. * @since 4.1
  1750. *
  1751. * Gets a const pointer to a color in a PackedColorArray.
  1752. *
  1753. * @param p_self A const pointer to a const PackedColorArray object.
  1754. * @param p_index The index of the Color to get.
  1755. *
  1756. * @return A const pointer to the requested Color.
  1757. */
  1758. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedColorArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1759. /**
  1760. * @name packed_float32_array_operator_index
  1761. * @since 4.1
  1762. *
  1763. * Gets a pointer to a 32-bit float in a PackedFloat32Array.
  1764. *
  1765. * @param p_self A pointer to a PackedFloat32Array object.
  1766. * @param p_index The index of the float to get.
  1767. *
  1768. * @return A pointer to the requested 32-bit float.
  1769. */
  1770. typedef float *(*GDExtensionInterfacePackedFloat32ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1771. /**
  1772. * @name packed_float32_array_operator_index_const
  1773. * @since 4.1
  1774. *
  1775. * Gets a const pointer to a 32-bit float in a PackedFloat32Array.
  1776. *
  1777. * @param p_self A const pointer to a PackedFloat32Array object.
  1778. * @param p_index The index of the float to get.
  1779. *
  1780. * @return A const pointer to the requested 32-bit float.
  1781. */
  1782. typedef const float *(*GDExtensionInterfacePackedFloat32ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1783. /**
  1784. * @name packed_float64_array_operator_index
  1785. * @since 4.1
  1786. *
  1787. * Gets a pointer to a 64-bit float in a PackedFloat64Array.
  1788. *
  1789. * @param p_self A pointer to a PackedFloat64Array object.
  1790. * @param p_index The index of the float to get.
  1791. *
  1792. * @return A pointer to the requested 64-bit float.
  1793. */
  1794. typedef double *(*GDExtensionInterfacePackedFloat64ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1795. /**
  1796. * @name packed_float64_array_operator_index_const
  1797. * @since 4.1
  1798. *
  1799. * Gets a const pointer to a 64-bit float in a PackedFloat64Array.
  1800. *
  1801. * @param p_self A const pointer to a PackedFloat64Array object.
  1802. * @param p_index The index of the float to get.
  1803. *
  1804. * @return A const pointer to the requested 64-bit float.
  1805. */
  1806. typedef const double *(*GDExtensionInterfacePackedFloat64ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1807. /**
  1808. * @name packed_int32_array_operator_index
  1809. * @since 4.1
  1810. *
  1811. * Gets a pointer to a 32-bit integer in a PackedInt32Array.
  1812. *
  1813. * @param p_self A pointer to a PackedInt32Array object.
  1814. * @param p_index The index of the integer to get.
  1815. *
  1816. * @return A pointer to the requested 32-bit integer.
  1817. */
  1818. typedef int32_t *(*GDExtensionInterfacePackedInt32ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1819. /**
  1820. * @name packed_int32_array_operator_index_const
  1821. * @since 4.1
  1822. *
  1823. * Gets a const pointer to a 32-bit integer in a PackedInt32Array.
  1824. *
  1825. * @param p_self A const pointer to a PackedInt32Array object.
  1826. * @param p_index The index of the integer to get.
  1827. *
  1828. * @return A const pointer to the requested 32-bit integer.
  1829. */
  1830. typedef const int32_t *(*GDExtensionInterfacePackedInt32ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1831. /**
  1832. * @name packed_int64_array_operator_index
  1833. * @since 4.1
  1834. *
  1835. * Gets a pointer to a 64-bit integer in a PackedInt64Array.
  1836. *
  1837. * @param p_self A pointer to a PackedInt64Array object.
  1838. * @param p_index The index of the integer to get.
  1839. *
  1840. * @return A pointer to the requested 64-bit integer.
  1841. */
  1842. typedef int64_t *(*GDExtensionInterfacePackedInt64ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1843. /**
  1844. * @name packed_int64_array_operator_index_const
  1845. * @since 4.1
  1846. *
  1847. * Gets a const pointer to a 64-bit integer in a PackedInt64Array.
  1848. *
  1849. * @param p_self A const pointer to a PackedInt64Array object.
  1850. * @param p_index The index of the integer to get.
  1851. *
  1852. * @return A const pointer to the requested 64-bit integer.
  1853. */
  1854. typedef const int64_t *(*GDExtensionInterfacePackedInt64ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1855. /**
  1856. * @name packed_string_array_operator_index
  1857. * @since 4.1
  1858. *
  1859. * Gets a pointer to a string in a PackedStringArray.
  1860. *
  1861. * @param p_self A pointer to a PackedStringArray object.
  1862. * @param p_index The index of the String to get.
  1863. *
  1864. * @return A pointer to the requested String.
  1865. */
  1866. typedef GDExtensionStringPtr (*GDExtensionInterfacePackedStringArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1867. /**
  1868. * @name packed_string_array_operator_index_const
  1869. * @since 4.1
  1870. *
  1871. * Gets a const pointer to a string in a PackedStringArray.
  1872. *
  1873. * @param p_self A const pointer to a PackedStringArray object.
  1874. * @param p_index The index of the String to get.
  1875. *
  1876. * @return A const pointer to the requested String.
  1877. */
  1878. typedef GDExtensionStringPtr (*GDExtensionInterfacePackedStringArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1879. /**
  1880. * @name packed_vector2_array_operator_index
  1881. * @since 4.1
  1882. *
  1883. * Gets a pointer to a Vector2 in a PackedVector2Array.
  1884. *
  1885. * @param p_self A pointer to a PackedVector2Array object.
  1886. * @param p_index The index of the Vector2 to get.
  1887. *
  1888. * @return A pointer to the requested Vector2.
  1889. */
  1890. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector2ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1891. /**
  1892. * @name packed_vector2_array_operator_index_const
  1893. * @since 4.1
  1894. *
  1895. * Gets a const pointer to a Vector2 in a PackedVector2Array.
  1896. *
  1897. * @param p_self A const pointer to a PackedVector2Array object.
  1898. * @param p_index The index of the Vector2 to get.
  1899. *
  1900. * @return A const pointer to the requested Vector2.
  1901. */
  1902. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector2ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1903. /**
  1904. * @name packed_vector3_array_operator_index
  1905. * @since 4.1
  1906. *
  1907. * Gets a pointer to a Vector3 in a PackedVector3Array.
  1908. *
  1909. * @param p_self A pointer to a PackedVector3Array object.
  1910. * @param p_index The index of the Vector3 to get.
  1911. *
  1912. * @return A pointer to the requested Vector3.
  1913. */
  1914. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector3ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1915. /**
  1916. * @name packed_vector3_array_operator_index_const
  1917. * @since 4.1
  1918. *
  1919. * Gets a const pointer to a Vector3 in a PackedVector3Array.
  1920. *
  1921. * @param p_self A const pointer to a PackedVector3Array object.
  1922. * @param p_index The index of the Vector3 to get.
  1923. *
  1924. * @return A const pointer to the requested Vector3.
  1925. */
  1926. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector3ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1927. /**
  1928. * @name array_operator_index
  1929. * @since 4.1
  1930. *
  1931. * Gets a pointer to a Variant in an Array.
  1932. *
  1933. * @param p_self A pointer to an Array object.
  1934. * @param p_index The index of the Variant to get.
  1935. *
  1936. * @return A pointer to the requested Variant.
  1937. */
  1938. typedef GDExtensionVariantPtr (*GDExtensionInterfaceArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1939. /**
  1940. * @name array_operator_index_const
  1941. * @since 4.1
  1942. *
  1943. * Gets a const pointer to a Variant in an Array.
  1944. *
  1945. * @param p_self A const pointer to an Array object.
  1946. * @param p_index The index of the Variant to get.
  1947. *
  1948. * @return A const pointer to the requested Variant.
  1949. */
  1950. typedef GDExtensionVariantPtr (*GDExtensionInterfaceArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1951. /**
  1952. * @name array_ref
  1953. * @since 4.1
  1954. *
  1955. * Sets an Array to be a reference to another Array object.
  1956. *
  1957. * @param p_self A pointer to the Array object to update.
  1958. * @param p_from A pointer to the Array object to reference.
  1959. */
  1960. typedef void (*GDExtensionInterfaceArrayRef)(GDExtensionTypePtr p_self, GDExtensionConstTypePtr p_from);
  1961. /**
  1962. * @name array_set_typed
  1963. * @since 4.1
  1964. *
  1965. * Makes an Array into a typed Array.
  1966. *
  1967. * @param p_self A pointer to the Array.
  1968. * @param p_type The type of Variant the Array will store.
  1969. * @param p_class_name A pointer to a StringName with the name of the object (if p_type is GDEXTENSION_VARIANT_TYPE_OBJECT).
  1970. * @param p_script A pointer to a Script object (if p_type is GDEXTENSION_VARIANT_TYPE_OBJECT and the base class is extended by a script).
  1971. */
  1972. typedef void (*GDExtensionInterfaceArraySetTyped)(GDExtensionTypePtr p_self, GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstVariantPtr p_script);
  1973. /* INTERFACE: Dictionary */
  1974. /**
  1975. * @name dictionary_operator_index
  1976. * @since 4.1
  1977. *
  1978. * Gets a pointer to a Variant in a Dictionary with the given key.
  1979. *
  1980. * @param p_self A pointer to a Dictionary object.
  1981. * @param p_key A pointer to a Variant representing the key.
  1982. *
  1983. * @return A pointer to a Variant representing the value at the given key.
  1984. */
  1985. typedef GDExtensionVariantPtr (*GDExtensionInterfaceDictionaryOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionConstVariantPtr p_key);
  1986. /**
  1987. * @name dictionary_operator_index_const
  1988. * @since 4.1
  1989. *
  1990. * Gets a const pointer to a Variant in a Dictionary with the given key.
  1991. *
  1992. * @param p_self A const pointer to a Dictionary object.
  1993. * @param p_key A pointer to a Variant representing the key.
  1994. *
  1995. * @return A const pointer to a Variant representing the value at the given key.
  1996. */
  1997. typedef GDExtensionVariantPtr (*GDExtensionInterfaceDictionaryOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionConstVariantPtr p_key);
  1998. /* INTERFACE: Object */
  1999. /**
  2000. * @name object_method_bind_call
  2001. * @since 4.1
  2002. *
  2003. * Calls a method on an Object.
  2004. *
  2005. * @param p_method_bind A pointer to the MethodBind representing the method on the Object's class.
  2006. * @param p_instance A pointer to the Object.
  2007. * @param p_args A pointer to a C array of Variants representing the arguments.
  2008. * @param p_arg_count The number of arguments.
  2009. * @param r_ret A pointer to Variant which will receive the return value.
  2010. * @param r_error A pointer to a GDExtensionCallError struct that will receive error information.
  2011. */
  2012. typedef void (*GDExtensionInterfaceObjectMethodBindCall)(GDExtensionMethodBindPtr p_method_bind, GDExtensionObjectPtr p_instance, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_arg_count, GDExtensionUninitializedVariantPtr r_ret, GDExtensionCallError *r_error);
  2013. /**
  2014. * @name object_method_bind_ptrcall
  2015. * @since 4.1
  2016. *
  2017. * Calls a method on an Object (using a "ptrcall").
  2018. *
  2019. * @param p_method_bind A pointer to the MethodBind representing the method on the Object's class.
  2020. * @param p_instance A pointer to the Object.
  2021. * @param p_args A pointer to a C array representing the arguments.
  2022. * @param r_ret A pointer to the Object that will receive the return value.
  2023. */
  2024. typedef void (*GDExtensionInterfaceObjectMethodBindPtrcall)(GDExtensionMethodBindPtr p_method_bind, GDExtensionObjectPtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  2025. /**
  2026. * @name object_destroy
  2027. * @since 4.1
  2028. *
  2029. * Destroys an Object.
  2030. *
  2031. * @param p_o A pointer to the Object.
  2032. */
  2033. typedef void (*GDExtensionInterfaceObjectDestroy)(GDExtensionObjectPtr p_o);
  2034. /**
  2035. * @name global_get_singleton
  2036. * @since 4.1
  2037. *
  2038. * Gets a global singleton by name.
  2039. *
  2040. * @param p_name A pointer to a StringName with the singleton name.
  2041. *
  2042. * @return A pointer to the singleton Object.
  2043. */
  2044. typedef GDExtensionObjectPtr (*GDExtensionInterfaceGlobalGetSingleton)(GDExtensionConstStringNamePtr p_name);
  2045. /**
  2046. * @name object_get_instance_binding
  2047. * @since 4.1
  2048. *
  2049. * Gets a pointer representing an Object's instance binding.
  2050. *
  2051. * @param p_o A pointer to the Object.
  2052. * @param p_library A token the library received by the GDExtension's entry point function.
  2053. * @param p_callbacks A pointer to a GDExtensionInstanceBindingCallbacks struct.
  2054. *
  2055. * @return
  2056. */
  2057. typedef void *(*GDExtensionInterfaceObjectGetInstanceBinding)(GDExtensionObjectPtr p_o, void *p_token, const GDExtensionInstanceBindingCallbacks *p_callbacks);
  2058. /**
  2059. * @name object_set_instance_binding
  2060. * @since 4.1
  2061. *
  2062. * Sets an Object's instance binding.
  2063. *
  2064. * @param p_o A pointer to the Object.
  2065. * @param p_library A token the library received by the GDExtension's entry point function.
  2066. * @param p_binding A pointer to the instance binding.
  2067. * @param p_callbacks A pointer to a GDExtensionInstanceBindingCallbacks struct.
  2068. */
  2069. typedef void (*GDExtensionInterfaceObjectSetInstanceBinding)(GDExtensionObjectPtr p_o, void *p_token, void *p_binding, const GDExtensionInstanceBindingCallbacks *p_callbacks);
  2070. /**
  2071. * @name object_free_instance_binding
  2072. * @since 4.2
  2073. *
  2074. * Free an Object's instance binding.
  2075. *
  2076. * @param p_o A pointer to the Object.
  2077. * @param p_library A token the library received by the GDExtension's entry point function.
  2078. */
  2079. typedef void (*GDExtensionInterfaceObjectFreeInstanceBinding)(GDExtensionObjectPtr p_o, void *p_token);
  2080. /**
  2081. * @name object_set_instance
  2082. * @since 4.1
  2083. *
  2084. * Sets an extension class instance on a Object.
  2085. *
  2086. * @param p_o A pointer to the Object.
  2087. * @param p_classname A pointer to a StringName with the registered extension class's name.
  2088. * @param p_instance A pointer to the extension class instance.
  2089. */
  2090. typedef void (*GDExtensionInterfaceObjectSetInstance)(GDExtensionObjectPtr p_o, GDExtensionConstStringNamePtr p_classname, GDExtensionClassInstancePtr p_instance); /* p_classname should be a registered extension class and should extend the p_o object's class. */
  2091. /**
  2092. * @name object_get_class_name
  2093. * @since 4.1
  2094. *
  2095. * Gets the class name of an Object.
  2096. *
  2097. * If the GDExtension wraps the Godot object in an abstraction specific to its class, this is the
  2098. * function that should be used to determine which wrapper to use.
  2099. *
  2100. * @param p_object A pointer to the Object.
  2101. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2102. * @param r_class_name A pointer to a String to receive the class name.
  2103. *
  2104. * @return true if successful in getting the class name; otherwise false.
  2105. */
  2106. typedef GDExtensionBool (*GDExtensionInterfaceObjectGetClassName)(GDExtensionConstObjectPtr p_object, GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringNamePtr r_class_name);
  2107. /**
  2108. * @name object_cast_to
  2109. * @since 4.1
  2110. *
  2111. * Casts an Object to a different type.
  2112. *
  2113. * @param p_object A pointer to the Object.
  2114. * @param p_class_tag A pointer uniquely identifying a built-in class in the ClassDB.
  2115. *
  2116. * @return Returns a pointer to the Object, or NULL if it can't be cast to the requested type.
  2117. */
  2118. typedef GDExtensionObjectPtr (*GDExtensionInterfaceObjectCastTo)(GDExtensionConstObjectPtr p_object, void *p_class_tag);
  2119. /**
  2120. * @name object_get_instance_from_id
  2121. * @since 4.1
  2122. *
  2123. * Gets an Object by its instance ID.
  2124. *
  2125. * @param p_instance_id The instance ID.
  2126. *
  2127. * @return A pointer to the Object.
  2128. */
  2129. typedef GDExtensionObjectPtr (*GDExtensionInterfaceObjectGetInstanceFromId)(GDObjectInstanceID p_instance_id);
  2130. /**
  2131. * @name object_get_instance_id
  2132. * @since 4.1
  2133. *
  2134. * Gets the instance ID from an Object.
  2135. *
  2136. * @param p_object A pointer to the Object.
  2137. *
  2138. * @return The instance ID.
  2139. */
  2140. typedef GDObjectInstanceID (*GDExtensionInterfaceObjectGetInstanceId)(GDExtensionConstObjectPtr p_object);
  2141. /**
  2142. * @name object_has_script_method
  2143. * @since 4.3
  2144. *
  2145. * Checks if this object has a script with the given method.
  2146. *
  2147. * @param p_object A pointer to the Object.
  2148. * @param p_method A pointer to a StringName identifying the method.
  2149. *
  2150. * @returns true if the object has a script and that script has a method with the given name. Returns false if the object has no script.
  2151. */
  2152. typedef GDExtensionBool (*GDExtensionInterfaceObjectHasScriptMethod)(GDExtensionConstObjectPtr p_object, GDExtensionConstStringNamePtr p_method);
  2153. /**
  2154. * @name object_call_script_method
  2155. * @since 4.3
  2156. *
  2157. * Call the given script method on this object.
  2158. *
  2159. * @param p_object A pointer to the Object.
  2160. * @param p_method A pointer to a StringName identifying the method.
  2161. * @param p_args A pointer to a C array of Variant.
  2162. * @param p_argument_count The number of arguments.
  2163. * @param r_return A pointer a Variant which will be assigned the return value.
  2164. * @param r_error A pointer the structure which will hold error information.
  2165. */
  2166. typedef void (*GDExtensionInterfaceObjectCallScriptMethod)(GDExtensionObjectPtr p_object, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionUninitializedVariantPtr r_return, GDExtensionCallError *r_error);
  2167. /* INTERFACE: Reference */
  2168. /**
  2169. * @name ref_get_object
  2170. * @since 4.1
  2171. *
  2172. * Gets the Object from a reference.
  2173. *
  2174. * @param p_ref A pointer to the reference.
  2175. *
  2176. * @return A pointer to the Object from the reference or NULL.
  2177. */
  2178. typedef GDExtensionObjectPtr (*GDExtensionInterfaceRefGetObject)(GDExtensionConstRefPtr p_ref);
  2179. /**
  2180. * @name ref_set_object
  2181. * @since 4.1
  2182. *
  2183. * Sets the Object referred to by a reference.
  2184. *
  2185. * @param p_ref A pointer to the reference.
  2186. * @param p_object A pointer to the Object to refer to.
  2187. */
  2188. typedef void (*GDExtensionInterfaceRefSetObject)(GDExtensionRefPtr p_ref, GDExtensionObjectPtr p_object);
  2189. /* INTERFACE: Script Instance */
  2190. /**
  2191. * @name script_instance_create
  2192. * @since 4.1
  2193. * @deprecated in Godot 4.2. Use `script_instance_create3` instead.
  2194. *
  2195. * Creates a script instance that contains the given info and instance data.
  2196. *
  2197. * @param p_info A pointer to a GDExtensionScriptInstanceInfo struct.
  2198. * @param p_instance_data A pointer to a data representing the script instance in the GDExtension. This will be passed to all the function pointers on p_info.
  2199. *
  2200. * @return A pointer to a ScriptInstanceExtension object.
  2201. */
  2202. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate)(const GDExtensionScriptInstanceInfo *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
  2203. /**
  2204. * @name script_instance_create2
  2205. * @since 4.2
  2206. * @deprecated in Godot 4.3. Use `script_instance_create3` instead.
  2207. *
  2208. * Creates a script instance that contains the given info and instance data.
  2209. *
  2210. * @param p_info A pointer to a GDExtensionScriptInstanceInfo2 struct.
  2211. * @param p_instance_data A pointer to a data representing the script instance in the GDExtension. This will be passed to all the function pointers on p_info.
  2212. *
  2213. * @return A pointer to a ScriptInstanceExtension object.
  2214. */
  2215. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate2)(const GDExtensionScriptInstanceInfo2 *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
  2216. /**
  2217. * @name script_instance_create3
  2218. * @since 4.3
  2219. *
  2220. * Creates a script instance that contains the given info and instance data.
  2221. *
  2222. * @param p_info A pointer to a GDExtensionScriptInstanceInfo3 struct.
  2223. * @param p_instance_data A pointer to a data representing the script instance in the GDExtension. This will be passed to all the function pointers on p_info.
  2224. *
  2225. * @return A pointer to a ScriptInstanceExtension object.
  2226. */
  2227. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate3)(const GDExtensionScriptInstanceInfo3 *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
  2228. /**
  2229. * @name placeholder_script_instance_create
  2230. * @since 4.2
  2231. *
  2232. * Creates a placeholder script instance for a given script and instance.
  2233. *
  2234. * This interface is optional as a custom placeholder could also be created with script_instance_create().
  2235. *
  2236. * @param p_language A pointer to a ScriptLanguage.
  2237. * @param p_script A pointer to a Script.
  2238. * @param p_owner A pointer to an Object.
  2239. *
  2240. * @return A pointer to a PlaceHolderScriptInstance object.
  2241. */
  2242. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfacePlaceHolderScriptInstanceCreate)(GDExtensionObjectPtr p_language, GDExtensionObjectPtr p_script, GDExtensionObjectPtr p_owner);
  2243. /**
  2244. * @name placeholder_script_instance_update
  2245. * @since 4.2
  2246. *
  2247. * Updates a placeholder script instance with the given properties and values.
  2248. *
  2249. * The passed in placeholder must be an instance of PlaceHolderScriptInstance
  2250. * such as the one returned by placeholder_script_instance_create().
  2251. *
  2252. * @param p_placeholder A pointer to a PlaceHolderScriptInstance.
  2253. * @param p_properties A pointer to an Array of Dictionary representing PropertyInfo.
  2254. * @param p_values A pointer to a Dictionary mapping StringName to Variant values.
  2255. */
  2256. typedef void (*GDExtensionInterfacePlaceHolderScriptInstanceUpdate)(GDExtensionScriptInstancePtr p_placeholder, GDExtensionConstTypePtr p_properties, GDExtensionConstTypePtr p_values);
  2257. /**
  2258. * @name object_get_script_instance
  2259. * @since 4.2
  2260. *
  2261. * Get the script instance data attached to this object.
  2262. *
  2263. * @param p_object A pointer to the Object.
  2264. * @param p_language A pointer to the language expected for this script instance.
  2265. *
  2266. * @return A GDExtensionScriptInstanceDataPtr that was attached to this object as part of script_instance_create.
  2267. */
  2268. typedef GDExtensionScriptInstanceDataPtr (*GDExtensionInterfaceObjectGetScriptInstance)(GDExtensionConstObjectPtr p_object, GDExtensionObjectPtr p_language);
  2269. /* INTERFACE: Callable */
  2270. /**
  2271. * @name callable_custom_create
  2272. * @since 4.2
  2273. * @deprecated in Godot 4.3. Use `callable_custom_create2` instead.
  2274. *
  2275. * Creates a custom Callable object from a function pointer.
  2276. *
  2277. * Provided struct can be safely freed once the function returns.
  2278. *
  2279. * @param r_callable A pointer that will receive the new Callable.
  2280. * @param p_callable_custom_info The info required to construct a Callable.
  2281. */
  2282. typedef void (*GDExtensionInterfaceCallableCustomCreate)(GDExtensionUninitializedTypePtr r_callable, GDExtensionCallableCustomInfo *p_callable_custom_info);
  2283. /**
  2284. * @name callable_custom_create2
  2285. * @since 4.3
  2286. *
  2287. * Creates a custom Callable object from a function pointer.
  2288. *
  2289. * Provided struct can be safely freed once the function returns.
  2290. *
  2291. * @param r_callable A pointer that will receive the new Callable.
  2292. * @param p_callable_custom_info The info required to construct a Callable.
  2293. */
  2294. typedef void (*GDExtensionInterfaceCallableCustomCreate2)(GDExtensionUninitializedTypePtr r_callable, GDExtensionCallableCustomInfo2 *p_callable_custom_info);
  2295. /**
  2296. * @name callable_custom_get_userdata
  2297. * @since 4.2
  2298. *
  2299. * Retrieves the userdata pointer from a custom Callable.
  2300. *
  2301. * If the Callable is not a custom Callable or the token does not match the one provided to callable_custom_create() via GDExtensionCallableCustomInfo then NULL will be returned.
  2302. *
  2303. * @param p_callable A pointer to a Callable.
  2304. * @param p_token A pointer to an address that uniquely identifies the GDExtension.
  2305. */
  2306. typedef void *(*GDExtensionInterfaceCallableCustomGetUserData)(GDExtensionConstTypePtr p_callable, void *p_token);
  2307. /* INTERFACE: ClassDB */
  2308. /**
  2309. * @name classdb_construct_object
  2310. * @since 4.1
  2311. *
  2312. * Constructs an Object of the requested class.
  2313. *
  2314. * The passed class must be a built-in godot class, or an already-registered extension class. In both cases, object_set_instance() should be called to fully initialize the object.
  2315. *
  2316. * @param p_classname A pointer to a StringName with the class name.
  2317. *
  2318. * @return A pointer to the newly created Object.
  2319. */
  2320. typedef GDExtensionObjectPtr (*GDExtensionInterfaceClassdbConstructObject)(GDExtensionConstStringNamePtr p_classname);
  2321. /**
  2322. * @name classdb_get_method_bind
  2323. * @since 4.1
  2324. *
  2325. * Gets a pointer to the MethodBind in ClassDB for the given class, method and hash.
  2326. *
  2327. * @param p_classname A pointer to a StringName with the class name.
  2328. * @param p_methodname A pointer to a StringName with the method name.
  2329. * @param p_hash A hash representing the function signature.
  2330. *
  2331. * @return A pointer to the MethodBind from ClassDB.
  2332. */
  2333. typedef GDExtensionMethodBindPtr (*GDExtensionInterfaceClassdbGetMethodBind)(GDExtensionConstStringNamePtr p_classname, GDExtensionConstStringNamePtr p_methodname, GDExtensionInt p_hash);
  2334. /**
  2335. * @name classdb_get_class_tag
  2336. * @since 4.1
  2337. *
  2338. * Gets a pointer uniquely identifying the given built-in class in the ClassDB.
  2339. *
  2340. * @param p_classname A pointer to a StringName with the class name.
  2341. *
  2342. * @return A pointer uniquely identifying the built-in class in the ClassDB.
  2343. */
  2344. typedef void *(*GDExtensionInterfaceClassdbGetClassTag)(GDExtensionConstStringNamePtr p_classname);
  2345. /* INTERFACE: ClassDB Extension */
  2346. /**
  2347. * @name classdb_register_extension_class
  2348. * @since 4.1
  2349. * @deprecated in Godot 4.2. Use `classdb_register_extension_class3` instead.
  2350. *
  2351. * Registers an extension class in the ClassDB.
  2352. *
  2353. * Provided struct can be safely freed once the function returns.
  2354. *
  2355. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2356. * @param p_class_name A pointer to a StringName with the class name.
  2357. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2358. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo struct.
  2359. */
  2360. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo *p_extension_funcs);
  2361. /**
  2362. * @name classdb_register_extension_class2
  2363. * @since 4.2
  2364. * @deprecated in Godot 4.3. Use `classdb_register_extension_class3` instead.
  2365. *
  2366. * Registers an extension class in the ClassDB.
  2367. *
  2368. * Provided struct can be safely freed once the function returns.
  2369. *
  2370. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2371. * @param p_class_name A pointer to a StringName with the class name.
  2372. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2373. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo2 struct.
  2374. */
  2375. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass2)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo2 *p_extension_funcs);
  2376. /**
  2377. * @name classdb_register_extension_class3
  2378. * @since 4.3
  2379. *
  2380. * Registers an extension class in the ClassDB.
  2381. *
  2382. * Provided struct can be safely freed once the function returns.
  2383. *
  2384. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2385. * @param p_class_name A pointer to a StringName with the class name.
  2386. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2387. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo2 struct.
  2388. */
  2389. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass3)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo3 *p_extension_funcs);
  2390. /**
  2391. * @name classdb_register_extension_class_method
  2392. * @since 4.1
  2393. *
  2394. * Registers a method on an extension class in the ClassDB.
  2395. *
  2396. * Provided struct can be safely freed once the function returns.
  2397. *
  2398. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2399. * @param p_class_name A pointer to a StringName with the class name.
  2400. * @param p_method_info A pointer to a GDExtensionClassMethodInfo struct.
  2401. */
  2402. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassMethod)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionClassMethodInfo *p_method_info);
  2403. /**
  2404. * @name classdb_register_extension_class_virtual_method
  2405. * @since 4.3
  2406. *
  2407. * Registers a virtual method on an extension class in ClassDB, that can be implemented by scripts or other extensions.
  2408. *
  2409. * Provided struct can be safely freed once the function returns.
  2410. *
  2411. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2412. * @param p_class_name A pointer to a StringName with the class name.
  2413. * @param p_method_info A pointer to a GDExtensionClassMethodInfo struct.
  2414. */
  2415. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassVirtualMethod)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionClassVirtualMethodInfo *p_method_info);
  2416. /**
  2417. * @name classdb_register_extension_class_integer_constant
  2418. * @since 4.1
  2419. *
  2420. * Registers an integer constant on an extension class in the ClassDB.
  2421. *
  2422. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2423. * @param p_class_name A pointer to a StringName with the class name.
  2424. * @param p_enum_name A pointer to a StringName with the enum name.
  2425. * @param p_constant_name A pointer to a StringName with the constant name.
  2426. * @param p_constant_value The constant value.
  2427. * @param p_is_bitfield Whether or not this is a bit field.
  2428. */
  2429. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassIntegerConstant)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_enum_name, GDExtensionConstStringNamePtr p_constant_name, GDExtensionInt p_constant_value, GDExtensionBool p_is_bitfield);
  2430. /**
  2431. * @name classdb_register_extension_class_property
  2432. * @since 4.1
  2433. *
  2434. * Registers a property on an extension class in the ClassDB.
  2435. *
  2436. * Provided struct can be safely freed once the function returns.
  2437. *
  2438. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2439. * @param p_class_name A pointer to a StringName with the class name.
  2440. * @param p_info A pointer to a GDExtensionPropertyInfo struct.
  2441. * @param p_setter A pointer to a StringName with the name of the setter method.
  2442. * @param p_getter A pointer to a StringName with the name of the getter method.
  2443. */
  2444. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassProperty)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionPropertyInfo *p_info, GDExtensionConstStringNamePtr p_setter, GDExtensionConstStringNamePtr p_getter);
  2445. /**
  2446. * @name classdb_register_extension_class_property_indexed
  2447. * @since 4.2
  2448. *
  2449. * Registers an indexed property on an extension class in the ClassDB.
  2450. *
  2451. * Provided struct can be safely freed once the function returns.
  2452. *
  2453. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2454. * @param p_class_name A pointer to a StringName with the class name.
  2455. * @param p_info A pointer to a GDExtensionPropertyInfo struct.
  2456. * @param p_setter A pointer to a StringName with the name of the setter method.
  2457. * @param p_getter A pointer to a StringName with the name of the getter method.
  2458. * @param p_index The index to pass as the first argument to the getter and setter methods.
  2459. */
  2460. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassPropertyIndexed)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionPropertyInfo *p_info, GDExtensionConstStringNamePtr p_setter, GDExtensionConstStringNamePtr p_getter, GDExtensionInt p_index);
  2461. /**
  2462. * @name classdb_register_extension_class_property_group
  2463. * @since 4.1
  2464. *
  2465. * Registers a property group on an extension class in the ClassDB.
  2466. *
  2467. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2468. * @param p_class_name A pointer to a StringName with the class name.
  2469. * @param p_group_name A pointer to a String with the group name.
  2470. * @param p_prefix A pointer to a String with the prefix used by properties in this group.
  2471. */
  2472. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassPropertyGroup)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringPtr p_group_name, GDExtensionConstStringPtr p_prefix);
  2473. /**
  2474. * @name classdb_register_extension_class_property_subgroup
  2475. * @since 4.1
  2476. *
  2477. * Registers a property subgroup on an extension class in the ClassDB.
  2478. *
  2479. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2480. * @param p_class_name A pointer to a StringName with the class name.
  2481. * @param p_subgroup_name A pointer to a String with the subgroup name.
  2482. * @param p_prefix A pointer to a String with the prefix used by properties in this subgroup.
  2483. */
  2484. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassPropertySubgroup)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringPtr p_subgroup_name, GDExtensionConstStringPtr p_prefix);
  2485. /**
  2486. * @name classdb_register_extension_class_signal
  2487. * @since 4.1
  2488. *
  2489. * Registers a signal on an extension class in the ClassDB.
  2490. *
  2491. * Provided structs can be safely freed once the function returns.
  2492. *
  2493. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2494. * @param p_class_name A pointer to a StringName with the class name.
  2495. * @param p_signal_name A pointer to a StringName with the signal name.
  2496. * @param p_argument_info A pointer to a GDExtensionPropertyInfo struct.
  2497. * @param p_argument_count The number of arguments the signal receives.
  2498. */
  2499. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassSignal)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_signal_name, const GDExtensionPropertyInfo *p_argument_info, GDExtensionInt p_argument_count);
  2500. /**
  2501. * @name classdb_unregister_extension_class
  2502. * @since 4.1
  2503. *
  2504. * Unregisters an extension class in the ClassDB.
  2505. *
  2506. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2507. * @param p_class_name A pointer to a StringName with the class name.
  2508. */
  2509. typedef void (*GDExtensionInterfaceClassdbUnregisterExtensionClass)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name); /* Unregistering a parent class before a class that inherits it will result in failure. Inheritors must be unregistered first. */
  2510. /**
  2511. * @name get_library_path
  2512. * @since 4.1
  2513. *
  2514. * Gets the path to the current GDExtension library.
  2515. *
  2516. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2517. * @param r_path A pointer to a String which will receive the path.
  2518. */
  2519. typedef void (*GDExtensionInterfaceGetLibraryPath)(GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringPtr r_path);
  2520. /**
  2521. * @name editor_add_plugin
  2522. * @since 4.1
  2523. *
  2524. * Adds an editor plugin.
  2525. *
  2526. * It's safe to call during initialization.
  2527. *
  2528. * @param p_class_name A pointer to a StringName with the name of a class (descending from EditorPlugin) which is already registered with ClassDB.
  2529. */
  2530. typedef void (*GDExtensionInterfaceEditorAddPlugin)(GDExtensionConstStringNamePtr p_class_name);
  2531. /**
  2532. * @name editor_remove_plugin
  2533. * @since 4.1
  2534. *
  2535. * Removes an editor plugin.
  2536. *
  2537. * @param p_class_name A pointer to a StringName with the name of a class that was previously added as an editor plugin.
  2538. */
  2539. typedef void (*GDExtensionInterfaceEditorRemovePlugin)(GDExtensionConstStringNamePtr p_class_name);
  2540. /**
  2541. * @name editor_help_load_xml_from_utf8_chars
  2542. * @since 4.3
  2543. *
  2544. * Loads new XML-formatted documentation data in the editor.
  2545. *
  2546. * The provided pointer can be immediately freed once the function returns.
  2547. *
  2548. * @param p_data A pointer to an UTF-8 encoded C string (null terminated).
  2549. */
  2550. typedef void (*GDExtensionsInterfaceEditorHelpLoadXmlFromUtf8Chars)(const char *p_data);
  2551. /**
  2552. * @name editor_help_load_xml_from_utf8_chars_and_len
  2553. * @since 4.3
  2554. *
  2555. * Loads new XML-formatted documentation data in the editor.
  2556. *
  2557. * The provided pointer can be immediately freed once the function returns.
  2558. *
  2559. * @param p_data A pointer to an UTF-8 encoded C string.
  2560. * @param p_size The number of bytes (not code units).
  2561. */
  2562. typedef void (*GDExtensionsInterfaceEditorHelpLoadXmlFromUtf8CharsAndLen)(const char *p_data, GDExtensionInt p_size);
  2563. #ifdef __cplusplus
  2564. }
  2565. #endif
  2566. #endif // GDEXTENSION_INTERFACE_H