y_classes.inc 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. /**
  2. * <library name="y_classes">
  3. * <section>
  4. * Description
  5. * </section>
  6. * Allows greater control over classes so not everyone has every class. Uses
  7. * a form of compression for locations.
  8. * <section>
  9. * Version
  10. * </section>
  11. * 0.1
  12. * <section>
  13. * Functions
  14. * </section>
  15. * <subsection>
  16. * Public
  17. * </subsection><ul>
  18. * <symbol name="Class_AddRemote">Adds a class to the remote master.</symbol>
  19. * <symbol name="Class_Remote">Updates settings remotely.</symbol>
  20. * </ul><subsection>
  21. * Core
  22. * </subsection><ul>
  23. * <symbol name="Class_Class">Sets up the system.</symbol>
  24. * <symbol name="Class_OnPlayerRequestSpawn">Called when a player requests a spawn.</symbol>
  25. * <symbol name="Class_OnPlayerRequestClass">Called when a player requests a class.</symbol>
  26. * <symbol name="Class_OnPlayerConnect">Called when a player connects.</symbol>
  27. * </ul><subsection>
  28. * Stock
  29. * </subsection><ul>
  30. * <symbol name="Class_Delete">Removes a class.</symbol>
  31. * <symbol name="Class_SetPlayer">Sets whether or not a player can use a class.</symbol>
  32. * <symbol name="Class_Disable">Disables a class.</symbol>
  33. * <symbol name="Class_Enable">Enables a disabled class.</symbol>
  34. * <symbol name="Class_AddForGroup">Adds a class to the system for only one group.</symbol>
  35. * <symbol name="Class_Add">Adds a class to the system.</symbol>
  36. * <symbol name="Class_AddEx">Adds a class to the system with group selection and setting.</symbol>
  37. * <symbol name="Class_AddWithGroupSet">Adds a class and sets their group on selection.</symbol>
  38. * <symbol name="Class_AllowReselection">Allows or disallows people to return to reselect a class.</symbol>
  39. * <symbol name="Class_RequireSpawnLogin">Require people to login before spawning.</symbol>
  40. * <symbol name="Class_RequireSelectionLogin">Require people to login before selecting.</symbol>
  41. * <symbol name="Class_RequireSelectionReg">Require people to register before selecting.</symbol>
  42. * <symbol name="Class_RequireSpawnReg">Require people to register before spawning.</symbol>
  43. * </ul><subsection>
  44. * Static
  45. * </subsection><ul>
  46. * <symbol name="Class_AddClass">Adds a class, wrapped by API and remote functions.</symbol>
  47. * </ul><subsection>
  48. * Inline
  49. * </subsection><ul>
  50. * <symbol name="Class_IsActive">Checks a class is active.</symbol>
  51. * <symbol name="Class_Enabled">Checks a class is enabled.</symbol>
  52. * <symbol name="Class_IsValid">Checks a class is valid.</symbol>
  53. * <symbol name="Class_X">Gets a classes x position.</symbol>
  54. * <symbol name="Class_Y">Gets a classes y position.</symbol>
  55. * <symbol name="Class_Z">Gets a classes z position.</symbol>
  56. * <symbol name="Class_A">Gets a classes angle.</symbol>
  57. * <symbol name="Class_Skin">Gets a classes skin.</symbol>
  58. * </ul><section>
  59. * Definitions
  60. * </section><ul>
  61. * <symbol name="MAX_CLASSES">Maximum number of classes storeable by the system.</symbol>
  62. * <symbol name="CLASS_LEFT">Flag for last internal class viewed.</symbol>
  63. * <symbol name="CLASS_MIDDLE">Flag for last internal class viewed.</symbol>
  64. * <symbol name="CLASS_RIGHT">Flag for last internal class viewed.</symbol>
  65. * </ul><section>
  66. * Enums
  67. * </section><ul>
  68. * <symbol name="e_CLASS_FLAGS">Small data for individual classes.</symbol>
  69. * <symbol name="E_CLASS">Class data structure.</symbol>
  70. * </ul><section>
  71. * Variables
  72. * </section>
  73. * <subsection>
  74. * Static
  75. * </subsection><ul>
  76. * <symbol name="YSI_g_sClasses">Data for classes.</symbol>
  77. * <symbol name="YSI_g_sPlayerClass">Player's current classes.</symbol>
  78. * <symbol name="YSI_g_sLeft">Handle for the first internal class.</symbol>
  79. * <symbol name="YSI_g_sMiddle">Handle for the second internal class.</symbol>
  80. * <symbol name="YSI_g_sRight">Handle for the third internal class.</symbol>
  81. * <symbol name="YSI_g_sClassCount">Number of classes stored.</symbol>
  82. * </ul>
  83. * </library>
  84. *//** *//*
  85. Legal:
  86. Version: MPL 1.1
  87. The contents of this file are subject to the Mozilla Public License Version
  88. 1.1 the "License"; you may not use this file except in compliance with
  89. the License. You may obtain a copy of the License at
  90. http://www.mozilla.org/MPL/
  91. Software distributed under the License is distributed on an "AS IS" basis,
  92. WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  93. for the specific language governing rights and limitations under the
  94. License.
  95. The Original Code is the YSI framework.
  96. The Initial Developer of the Original Code is Alex "Y_Less" Cole.
  97. Portions created by the Initial Developer are Copyright C 2011
  98. the Initial Developer. All Rights Reserved.
  99. Contributors:
  100. Y_Less
  101. koolk
  102. JoeBullet/Google63
  103. g_aSlice/Slice
  104. Misiur
  105. samphunter
  106. tianmeta
  107. maddinat0r
  108. spacemud
  109. Crayder
  110. Dayvison
  111. Ahmad45123
  112. Zeex
  113. irinel1996
  114. Yiin-
  115. Chaprnks
  116. Konstantinos
  117. Masterchen09
  118. Southclaws
  119. PatchwerkQWER
  120. m0k1
  121. paulommu
  122. udan111
  123. Thanks:
  124. JoeBullet/Google63 - Handy arbitrary ASM jump code using SCTRL.
  125. ZeeX - Very productive conversations.
  126. koolk - IsPlayerinAreaEx code.
  127. TheAlpha - Danish translation.
  128. breadfish - German translation.
  129. Fireburn - Dutch translation.
  130. yom - French translation.
  131. 50p - Polish translation.
  132. Zamaroht - Spanish translation.
  133. Los - Portuguese translation.
  134. Dracoblue, sintax, mabako, Xtreme, other coders - Producing other modes for
  135. me to strive to better.
  136. Pixels^ - Running XScripters where the idea was born.
  137. Matite - Pestering me to release it and using it.
  138. Very special thanks to:
  139. Thiadmer - PAWN, whose limits continue to amaze me!
  140. Kye/Kalcor - SA:MP.
  141. SA:MP Team past, present and future - SA:MP.
  142. Optional plugins:
  143. Gamer_Z - GPS.
  144. Incognito - Streamer.
  145. Me - sscanf2, fixes2, Whirlpool.
  146. */
  147. #if !defined _INC_y_classes
  148. #tryinclude "y_classes\y_classes_entry"
  149. #endif
  150. #if !defined _INC_y_classes
  151. #tryinclude "YSI_Visual\y_classes\y_classes_entry"
  152. #endif
  153. #if !defined _INC_y_classes
  154. #tryinclude "YSI\YSI_Visual\y_classes\y_classes_entry"
  155. #endif
  156. #if !defined _INC_y_classes
  157. #tryinclude <YSI_Visual\y_classes\y_classes_entry>
  158. #endif
  159. #if !defined _INC_y_classes
  160. #tryinclude <YSI\YSI_Visual\y_classes\y_classes_entry>
  161. #endif
  162. #if !defined _INC_y_classes
  163. #error Could not find y_classes
  164. #endif