Blizzard_APIDocumentation/LossOfControlDocumentation.lua

Blizzard_APIDocumentation/LossOfControlDocumentation.lua (9.1.5.40906; unchanged since 9.0.1.36230)
  1. local LossOfControl =
  2. {
  3. Name = "LossOfControl",
  4. Type = "System",
  5. Namespace = "C_LossOfControl",
  6. Functions =
  7. {
  8. {
  9. Name = "GetActiveLossOfControlData",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "index", Type = "number", Nilable = false },
  14. },
  15. Returns =
  16. {
  17. { Name = "event", Type = "LossOfControlData", Nilable = true },
  18. },
  19. },
  20. {
  21. Name = "GetActiveLossOfControlDataByUnit",
  22. Type = "Function",
  23. Arguments =
  24. {
  25. { Name = "unitToken", Type = "string", Nilable = false },
  26. { Name = "index", Type = "number", Nilable = false },
  27. },
  28. Returns =
  29. {
  30. { Name = "event", Type = "LossOfControlData", Nilable = true },
  31. },
  32. },
  33. {
  34. Name = "GetActiveLossOfControlDataCount",
  35. Type = "Function",
  36. Returns =
  37. {
  38. { Name = "count", Type = "number", Nilable = false },
  39. },
  40. },
  41. {
  42. Name = "GetActiveLossOfControlDataCountByUnit",
  43. Type = "Function",
  44. Arguments =
  45. {
  46. { Name = "unitToken", Type = "string", Nilable = false },
  47. },
  48. Returns =
  49. {
  50. { Name = "count", Type = "number", Nilable = false },
  51. },
  52. },
  53. },
  54. Events =
  55. {
  56. {
  57. Name = "LossOfControlAdded",
  58. Type = "Event",
  59. LiteralName = "LOSS_OF_CONTROL_ADDED",
  60. Payload =
  61. {
  62. { Name = "effectIndex", Type = "number", Nilable = false },
  63. },
  64. },
  65. {
  66. Name = "LossOfControlCommentatorAdded",
  67. Type = "Event",
  68. LiteralName = "LOSS_OF_CONTROL_COMMENTATOR_ADDED",
  69. Payload =
  70. {
  71. { Name = "victim", Type = "string", Nilable = false },
  72. { Name = "effectIndex", Type = "number", Nilable = false },
  73. },
  74. },
  75. {
  76. Name = "LossOfControlCommentatorUpdate",
  77. Type = "Event",
  78. LiteralName = "LOSS_OF_CONTROL_COMMENTATOR_UPDATE",
  79. Payload =
  80. {
  81. { Name = "victim", Type = "string", Nilable = false },
  82. },
  83. },
  84. {
  85. Name = "LossOfControlUpdate",
  86. Type = "Event",
  87. LiteralName = "LOSS_OF_CONTROL_UPDATE",
  88. },
  89. {
  90. Name = "PlayerControlGained",
  91. Type = "Event",
  92. LiteralName = "PLAYER_CONTROL_GAINED",
  93. },
  94. {
  95. Name = "PlayerControlLost",
  96. Type = "Event",
  97. LiteralName = "PLAYER_CONTROL_LOST",
  98. },
  99. },
  100. Tables =
  101. {
  102. {
  103. Name = "LossOfControlData",
  104. Type = "Structure",
  105. Fields =
  106. {
  107. { Name = "locType", Type = "string", Nilable = false },
  108. { Name = "spellID", Type = "number", Nilable = false },
  109. { Name = "displayText", Type = "string", Nilable = false },
  110. { Name = "iconTexture", Type = "number", Nilable = false },
  111. { Name = "startTime", Type = "number", Nilable = true },
  112. { Name = "timeRemaining", Type = "number", Nilable = true },
  113. { Name = "duration", Type = "number", Nilable = true },
  114. { Name = "lockoutSchool", Type = "number", Nilable = false },
  115. { Name = "priority", Type = "number", Nilable = false },
  116. { Name = "displayType", Type = "number", Nilable = false },
  117. },
  118. },
  119. },
  120. };
  121. APIDocumentation:AddDocumentationTable(LossOfControl);