class_animationnodeblendspace2d.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AnimationNodeBlendSpace2D:
  5. AnimationNodeBlendSpace2D
  6. =========================
  7. **Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +-------------------------------+-----------------------------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_auto_triangles>` |
  15. +-------------------------------+-----------------------------------------------------------------------+
  16. | :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_max_space>` |
  17. +-------------------------------+-----------------------------------------------------------------------+
  18. | :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_min_space>` |
  19. +-------------------------------+-----------------------------------------------------------------------+
  20. | :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_snap>` |
  21. +-------------------------------+-----------------------------------------------------------------------+
  22. | :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_x_label>` |
  23. +-------------------------------+-----------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_y_label>` |
  25. +-------------------------------+-----------------------------------------------------------------------+
  26. Methods
  27. -------
  28. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_add_blend_point>` **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` at_index=-1 **)** |
  30. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`add_triangle<class_AnimationNodeBlendSpace2D_add_triangle>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)** |
  32. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace2D_get_blend_point_count>` **(** **)** const |
  34. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace2D_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** const |
  36. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Vector2<class_Vector2>` | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace2D_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** const |
  38. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`get_triangle_count<class_AnimationNodeBlendSpace2D_get_triangle_count>` **(** **)** const |
  40. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`get_triangle_point<class_AnimationNodeBlendSpace2D_get_triangle_point>` **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)** |
  42. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_remove_blend_point>` **(** :ref:`int<class_int>` point **)** |
  44. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`remove_triangle<class_AnimationNodeBlendSpace2D_remove_triangle>` **(** :ref:`int<class_int>` triangle **)** |
  46. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace2D_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** |
  48. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace2D_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)** |
  50. +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. Property Descriptions
  52. ---------------------
  53. .. _class_AnimationNodeBlendSpace2D_auto_triangles:
  54. - :ref:`bool<class_bool>` **auto_triangles**
  55. +----------+---------------------------+
  56. | *Setter* | set_auto_triangles(value) |
  57. +----------+---------------------------+
  58. | *Getter* | get_auto_triangles() |
  59. +----------+---------------------------+
  60. .. _class_AnimationNodeBlendSpace2D_max_space:
  61. - :ref:`Vector2<class_Vector2>` **max_space**
  62. +----------+----------------------+
  63. | *Setter* | set_max_space(value) |
  64. +----------+----------------------+
  65. | *Getter* | get_max_space() |
  66. +----------+----------------------+
  67. .. _class_AnimationNodeBlendSpace2D_min_space:
  68. - :ref:`Vector2<class_Vector2>` **min_space**
  69. +----------+----------------------+
  70. | *Setter* | set_min_space(value) |
  71. +----------+----------------------+
  72. | *Getter* | get_min_space() |
  73. +----------+----------------------+
  74. .. _class_AnimationNodeBlendSpace2D_snap:
  75. - :ref:`Vector2<class_Vector2>` **snap**
  76. +----------+-----------------+
  77. | *Setter* | set_snap(value) |
  78. +----------+-----------------+
  79. | *Getter* | get_snap() |
  80. +----------+-----------------+
  81. .. _class_AnimationNodeBlendSpace2D_x_label:
  82. - :ref:`String<class_String>` **x_label**
  83. +----------+--------------------+
  84. | *Setter* | set_x_label(value) |
  85. +----------+--------------------+
  86. | *Getter* | get_x_label() |
  87. +----------+--------------------+
  88. .. _class_AnimationNodeBlendSpace2D_y_label:
  89. - :ref:`String<class_String>` **y_label**
  90. +----------+--------------------+
  91. | *Setter* | set_y_label(value) |
  92. +----------+--------------------+
  93. | *Getter* | get_y_label() |
  94. +----------+--------------------+
  95. Method Descriptions
  96. -------------------
  97. .. _class_AnimationNodeBlendSpace2D_add_blend_point:
  98. - void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` at_index=-1 **)**
  99. .. _class_AnimationNodeBlendSpace2D_add_triangle:
  100. - void **add_triangle** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)**
  101. .. _class_AnimationNodeBlendSpace2D_get_blend_point_count:
  102. - :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
  103. .. _class_AnimationNodeBlendSpace2D_get_blend_point_node:
  104. - :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
  105. .. _class_AnimationNodeBlendSpace2D_get_blend_point_position:
  106. - :ref:`Vector2<class_Vector2>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
  107. .. _class_AnimationNodeBlendSpace2D_get_triangle_count:
  108. - :ref:`int<class_int>` **get_triangle_count** **(** **)** const
  109. .. _class_AnimationNodeBlendSpace2D_get_triangle_point:
  110. - :ref:`int<class_int>` **get_triangle_point** **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)**
  111. .. _class_AnimationNodeBlendSpace2D_remove_blend_point:
  112. - void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
  113. .. _class_AnimationNodeBlendSpace2D_remove_triangle:
  114. - void **remove_triangle** **(** :ref:`int<class_int>` triangle **)**
  115. .. _class_AnimationNodeBlendSpace2D_set_blend_point_node:
  116. - void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
  117. .. _class_AnimationNodeBlendSpace2D_set_blend_point_position:
  118. - void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)**