Blizzard_APIDocumentation/CursorDocumentation.lua

Blizzard_APIDocumentation/CursorDocumentation.lua (9.1.5.40906; unchanged since 9.1.0.39229)
  1. local Cursor =
  2. {
  3. Name = "Cursor",
  4. Type = "System",
  5. Namespace = "C_Cursor",
  6. Functions =
  7. {
  8. {
  9. Name = "DropCursorCommunitiesStream",
  10. Type = "Function",
  11. },
  12. {
  13. Name = "GetCursorCommunitiesStream",
  14. Type = "Function",
  15. Returns =
  16. {
  17. { Name = "clubId", Type = "string", Nilable = false },
  18. { Name = "streamId", Type = "string", Nilable = false },
  19. },
  20. },
  21. {
  22. Name = "GetCursorItem",
  23. Type = "Function",
  24. Returns =
  25. {
  26. { Name = "item", Type = "table", Mixin = "ItemLocationMixin", Nilable = false },
  27. },
  28. },
  29. {
  30. Name = "SetCursorCommunitiesStream",
  31. Type = "Function",
  32. Arguments =
  33. {
  34. { Name = "clubId", Type = "string", Nilable = false },
  35. { Name = "streamId", Type = "string", Nilable = false },
  36. },
  37. },
  38. },
  39. Events =
  40. {
  41. {
  42. Name = "BattlePetCursorClear",
  43. Type = "Event",
  44. LiteralName = "BATTLE_PET_CURSOR_CLEAR",
  45. },
  46. {
  47. Name = "CommunitiesStreamCursorClear",
  48. Type = "Event",
  49. LiteralName = "COMMUNITIES_STREAM_CURSOR_CLEAR",
  50. },
  51. {
  52. Name = "CursorChanged",
  53. Type = "Event",
  54. LiteralName = "CURSOR_CHANGED",
  55. Payload =
  56. {
  57. { Name = "isDefault", Type = "bool", Nilable = false },
  58. { Name = "newCursorType", Type = "UICursorType", Nilable = false },
  59. { Name = "oldCursorType", Type = "UICursorType", Nilable = false },
  60. { Name = "oldCursorVirtualID", Type = "number", Nilable = false },
  61. },
  62. },
  63. {
  64. Name = "CursorUpdate",
  65. Type = "Event",
  66. LiteralName = "CURSOR_UPDATE",
  67. },
  68. {
  69. Name = "MountCursorClear",
  70. Type = "Event",
  71. LiteralName = "MOUNT_CURSOR_CLEAR",
  72. },
  73. },
  74. Tables =
  75. {
  76. {
  77. Name = "UICursorType",
  78. Type = "Enumeration",
  79. NumValues = 21,
  80. MinValue = 0,
  81. MaxValue = 21,
  82. Fields =
  83. {
  84. { Name = "Default", Type = "UICursorType", EnumValue = 0 },
  85. { Name = "Item", Type = "UICursorType", EnumValue = 1 },
  86. { Name = "Money", Type = "UICursorType", EnumValue = 2 },
  87. { Name = "Spell", Type = "UICursorType", EnumValue = 3 },
  88. { Name = "PetAction", Type = "UICursorType", EnumValue = 4 },
  89. { Name = "Merchant", Type = "UICursorType", EnumValue = 5 },
  90. { Name = "ActionBar", Type = "UICursorType", EnumValue = 6 },
  91. { Name = "Macro", Type = "UICursorType", EnumValue = 7 },
  92. { Name = "AmmoObsolete", Type = "UICursorType", EnumValue = 9 },
  93. { Name = "Pet", Type = "UICursorType", EnumValue = 10 },
  94. { Name = "GuildBank", Type = "UICursorType", EnumValue = 11 },
  95. { Name = "GuildBankMoney", Type = "UICursorType", EnumValue = 12 },
  96. { Name = "EquipmentSet", Type = "UICursorType", EnumValue = 13 },
  97. { Name = "Currency", Type = "UICursorType", EnumValue = 14 },
  98. { Name = "Flyout", Type = "UICursorType", EnumValue = 15 },
  99. { Name = "VoidItem", Type = "UICursorType", EnumValue = 16 },
  100. { Name = "BattlePet", Type = "UICursorType", EnumValue = 17 },
  101. { Name = "Mount", Type = "UICursorType", EnumValue = 18 },
  102. { Name = "Toy", Type = "UICursorType", EnumValue = 19 },
  103. { Name = "CommunitiesStream", Type = "UICursorType", EnumValue = 20 },
  104. { Name = "ConduitCollectionItem", Type = "UICursorType", EnumValue = 21 },
  105. },
  106. },
  107. },
  108. };
  109. APIDocumentation:AddDocumentationTable(Cursor);