Reference.xml 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Reference" inherits="Object" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Base class for anything that keeps a reference count.
  5. </brief_description>
  6. <description>
  7. Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="init_ref">
  15. <return type="bool">
  16. </return>
  17. <description>
  18. </description>
  19. </method>
  20. <method name="reference">
  21. <return type="bool">
  22. </return>
  23. <description>
  24. Increase the internal reference counter. Use this only if you really know what you are doing.
  25. </description>
  26. </method>
  27. <method name="unreference">
  28. <return type="bool">
  29. </return>
  30. <description>
  31. Decrease the internal reference counter. Use this only if you really know what you are doing.
  32. </description>
  33. </method>
  34. </methods>
  35. <constants>
  36. </constants>
  37. </class>