@tlua/gmod 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (272) hide show
  1. package/package.json +1 -1
  2. package/types/achievementicon.d.tlua +0 -1
  3. package/types/achievements.d.tlua +15 -16
  4. package/types/ai.d.tlua +5 -6
  5. package/types/ai_schedule.d.tlua +0 -1
  6. package/types/ai_task.d.tlua +0 -1
  7. package/types/angle.d.tlua +18 -19
  8. package/types/avatarimage.d.tlua +0 -1
  9. package/types/awesomium.d.tlua +0 -1
  10. package/types/baseclass.d.tlua +1 -3
  11. package/types/bf_read.d.tlua +10 -12
  12. package/types/bit.d.tlua +11 -12
  13. package/types/button.d.tlua +0 -1
  14. package/types/cam.d.tlua +16 -17
  15. package/types/ceffectdata.d.tlua +31 -33
  16. package/types/chat.d.tlua +5 -6
  17. package/types/checkbutton.d.tlua +0 -1
  18. package/types/cleanup.d.tlua +7 -8
  19. package/types/cluaemitter.d.tlua +11 -13
  20. package/types/clualocomotion.d.tlua +39 -41
  21. package/types/cluaparticle.d.tlua +43 -45
  22. package/types/cmovedata.d.tlua +46 -48
  23. package/types/cnavarea.d.tlua +76 -78
  24. package/types/cnavladder.d.tlua +21 -23
  25. package/types/cnewparticleeffect.d.tlua +25 -27
  26. package/types/color.d.tlua +28 -29
  27. package/types/concommand.d.tlua +4 -5
  28. package/types/constraint.d.tlua +28 -29
  29. package/types/construct.d.tlua +1 -2
  30. package/types/contentheader.d.tlua +1 -3
  31. package/types/contenticon.d.tlua +7 -9
  32. package/types/contentsidebar.d.tlua +2 -4
  33. package/types/contentsidebartoolbox.d.tlua +0 -1
  34. package/types/contextbase.d.tlua +2 -4
  35. package/types/controlpanel.d.tlua +11 -14
  36. package/types/controlpresets.d.tlua +11 -13
  37. package/types/convar.d.tlua +15 -17
  38. package/types/cookie.d.tlua +3 -4
  39. package/types/coroutine.d.tlua +7 -8
  40. package/types/crecipientfilter.d.tlua +15 -17
  41. package/types/csent.d.tlua +0 -1
  42. package/types/csoundpatch.d.tlua +13 -15
  43. package/types/ctakedamageinfo.d.tlua +32 -34
  44. package/types/ctrllistbox.d.tlua +0 -1
  45. package/types/ctrlnumpad.d.tlua +5 -7
  46. package/types/cusercmd.d.tlua +26 -28
  47. package/types/custom_entity_fields.d.tlua +0 -1
  48. package/types/cvars.d.tlua +6 -7
  49. package/types/dadjustablemodelpanel.d.tlua +5 -7
  50. package/types/dalphabar.d.tlua +1 -3
  51. package/types/dbinder.d.tlua +2 -4
  52. package/types/dbubblecontainer.d.tlua +0 -2
  53. package/types/dbutton.d.tlua +6 -8
  54. package/types/dcategoryheader.d.tlua +0 -1
  55. package/types/dcategorylist.d.tlua +0 -1
  56. package/types/dcheckbox.d.tlua +3 -5
  57. package/types/dcheckboxlabel.d.tlua +9 -10
  58. package/types/dcollapsiblecategory.d.tlua +21 -23
  59. package/types/dcolorbutton.d.tlua +5 -7
  60. package/types/dcolorcombo.d.tlua +3 -5
  61. package/types/dcolorcube.d.tlua +11 -13
  62. package/types/dcolormixer.d.tlua +25 -27
  63. package/types/dcolorpalette.d.tlua +21 -23
  64. package/types/dcolumnsheet.d.tlua +3 -5
  65. package/types/dcombobox.d.tlua +15 -17
  66. package/types/ddragbase.d.tlua +11 -13
  67. package/types/ddrawer.d.tlua +6 -8
  68. package/types/debug.d.tlua +16 -19
  69. package/types/debugoverlay.d.tlua +11 -12
  70. package/types/dentityproperties.d.tlua +3 -5
  71. package/types/derma.d.tlua +10 -11
  72. package/types/dexpandbutton.d.tlua +1 -3
  73. package/types/dfilebrowser.d.tlua +20 -21
  74. package/types/dform.d.tlua +16 -18
  75. package/types/dframe.d.tlua +24 -25
  76. package/types/dgrid.d.tlua +9 -11
  77. package/types/dhorizontaldivider.d.tlua +18 -20
  78. package/types/dhorizontalscroller.d.tlua +9 -11
  79. package/types/dhscrollbar.d.tlua +9 -11
  80. package/types/dhtml.d.tlua +6 -8
  81. package/types/dhtmlcontrols.d.tlua +5 -6
  82. package/types/diconbrowser.d.tlua +9 -11
  83. package/types/diconlayout.d.tlua +16 -18
  84. package/types/dimage.d.tlua +17 -20
  85. package/types/dimagebutton.d.tlua +9 -10
  86. package/types/dkillicon.d.tlua +0 -1
  87. package/types/dlabel.d.tlua +31 -33
  88. package/types/dlabeleditable.d.tlua +3 -5
  89. package/types/dlabelurl.d.tlua +8 -10
  90. package/types/dlistbox.d.tlua +6 -8
  91. package/types/dlistboxitem.d.tlua +2 -4
  92. package/types/dlistlayout.d.tlua +0 -1
  93. package/types/dlistview.d.tlua +32 -34
  94. package/types/dlistview_column.d.tlua +12 -14
  95. package/types/dlistview_columnplain.d.tlua +0 -1
  96. package/types/dlistview_draggerbar.d.tlua +0 -1
  97. package/types/dlistview_line.d.tlua +11 -13
  98. package/types/dlistviewheaderlabel.d.tlua +0 -1
  99. package/types/dlistviewlabel.d.tlua +0 -1
  100. package/types/dlistviewline.d.tlua +0 -1
  101. package/types/dmenu.d.tlua +23 -28
  102. package/types/dmenubar.d.tlua +2 -7
  103. package/types/dmenuoption.d.tlua +11 -13
  104. package/types/dmenuoptioncvar.d.tlua +4 -6
  105. package/types/dmodelpanel.d.tlua +20 -22
  106. package/types/dmodelselect.d.tlua +0 -2
  107. package/types/dmodelselectmulti.d.tlua +0 -2
  108. package/types/dnotify.d.tlua +8 -10
  109. package/types/dnumberscratch.d.tlua +24 -26
  110. package/types/dnumberwang.d.tlua +14 -16
  111. package/types/dnumpad.d.tlua +0 -1
  112. package/types/dnumslider.d.tlua +17 -18
  113. package/types/dpanel.d.tlua +12 -14
  114. package/types/dpanellist.d.tlua +11 -12
  115. package/types/dpaneloverlay.d.tlua +5 -7
  116. package/types/dpanelselect.d.tlua +0 -1
  117. package/types/dpanpanel.d.tlua +4 -6
  118. package/types/dprogress.d.tlua +1 -3
  119. package/types/dproperties.d.tlua +2 -4
  120. package/types/dproperty_boolean.d.tlua +0 -1
  121. package/types/dproperty_combo.d.tlua +1 -3
  122. package/types/dproperty_entity.d.tlua +0 -1
  123. package/types/dproperty_float.d.tlua +0 -1
  124. package/types/dproperty_generic.d.tlua +3 -5
  125. package/types/dproperty_int.d.tlua +0 -1
  126. package/types/dproperty_vectorcolor.d.tlua +0 -1
  127. package/types/dpropertysheet.d.tlua +15 -17
  128. package/types/dragndrop.d.tlua +10 -11
  129. package/types/draw.d.tlua +10 -12
  130. package/types/drgbpicker.d.tlua +2 -4
  131. package/types/drive.d.tlua +11 -13
  132. package/types/dscrollbargrip.d.tlua +0 -1
  133. package/types/dscrollpanel.d.tlua +10 -11
  134. package/types/dshape.d.tlua +5 -7
  135. package/types/dsizetocontents.d.tlua +3 -5
  136. package/types/dslider.d.tlua +26 -28
  137. package/types/dsprite.d.tlua +7 -9
  138. package/types/dtab.d.tlua +6 -8
  139. package/types/dtextentry.d.tlua +41 -43
  140. package/types/dtilelayout.d.tlua +19 -21
  141. package/types/dtooltip.d.tlua +4 -6
  142. package/types/dtree.d.tlua +14 -16
  143. package/types/dtree_node.d.tlua +66 -68
  144. package/types/dtree_node_button.d.tlua +0 -1
  145. package/types/duplicator.d.tlua +29 -31
  146. package/types/dverticaldivider.d.tlua +21 -23
  147. package/types/dvscrollbar.d.tlua +9 -11
  148. package/types/editablepanel.d.tlua +0 -1
  149. package/types/effect.d.tlua +2 -4
  150. package/types/effects.d.tlua +6 -7
  151. package/types/engine.d.tlua +21 -22
  152. package/types/entity.d.tlua +643 -674
  153. package/types/ents.d.tlua +19 -25
  154. package/types/enums.d.tlua +0 -1
  155. package/types/file.d.tlua +39 -40
  156. package/types/file_class.d.tlua +0 -1
  157. package/types/fingerposer.d.tlua +0 -1
  158. package/types/fingervar.d.tlua +0 -1
  159. package/types/frame.d.tlua +0 -1
  160. package/types/frame_blend.d.tlua +7 -8
  161. package/types/game.d.tlua +39 -40
  162. package/types/gameevent.d.tlua +0 -1
  163. package/types/gamemode.d.tlua +2 -4
  164. package/types/global.d.tlua +0 -18
  165. package/types/gm.d.tlua +266 -268
  166. package/types/gmod.d.tlua +0 -1
  167. package/types/gmsave.d.tlua +4 -5
  168. package/types/gui.d.tlua +21 -22
  169. package/types/gwen.d.tlua +3 -4
  170. package/types/halo.d.tlua +2 -3
  171. package/types/hammer.d.tlua +0 -1
  172. package/types/hook.d.tlua +4 -5
  173. package/types/html.d.tlua +0 -1
  174. package/types/http.d.tlua +1 -2
  175. package/types/iconeditor.d.tlua +9 -11
  176. package/types/igmodaudiochannel.d.tlua +40 -42
  177. package/types/imagecheckbox.d.tlua +2 -4
  178. package/types/imaterial.d.tlua +25 -27
  179. package/types/imesh.d.tlua +4 -6
  180. package/types/input.d.tlua +22 -25
  181. package/types/invalidateinternalentitycache.d.tlua +0 -1
  182. package/types/irestore.d.tlua +8 -10
  183. package/types/isave.d.tlua +8 -10
  184. package/types/itexture.d.tlua +9 -11
  185. package/types/ivideowriter.d.tlua +4 -6
  186. package/types/jit.d.tlua +16 -17
  187. package/types/killicon.d.tlua +7 -8
  188. package/types/label.d.tlua +0 -1
  189. package/types/language.d.tlua +1 -2
  190. package/types/list.d.tlua +8 -9
  191. package/types/makeballoon.d.tlua +0 -1
  192. package/types/markup.d.tlua +2 -3
  193. package/types/markupobject.d.tlua +4 -6
  194. package/types/material.d.tlua +0 -1
  195. package/types/math.d.tlua +83 -84
  196. package/types/matproxy.d.tlua +3 -4
  197. package/types/matselect.d.tlua +9 -11
  198. package/types/menu.d.tlua +0 -1
  199. package/types/menubar.d.tlua +2 -3
  200. package/types/mesh.d.tlua +19 -20
  201. package/types/modelimage.d.tlua +0 -1
  202. package/types/motionsensor.d.tlua +10 -11
  203. package/types/navmesh.d.tlua +26 -27
  204. package/types/net.d.tlua +51 -53
  205. package/types/nextbot.d.tlua +34 -37
  206. package/types/notification.d.tlua +2 -3
  207. package/types/npc.d.tlua +180 -182
  208. package/types/numpad.d.tlua +7 -8
  209. package/types/os.d.tlua +3 -5
  210. package/types/package.d.tlua +0 -1
  211. package/types/panel.d.tlua +329 -331
  212. package/types/panellist.d.tlua +0 -1
  213. package/types/pathfollower.d.tlua +30 -32
  214. package/types/permissions.d.tlua +6 -7
  215. package/types/physcollide.d.tlua +2 -4
  216. package/types/physenv.d.tlua +11 -12
  217. package/types/physobj.d.tlua +77 -79
  218. package/types/pixelvis_handle_t.d.tlua +0 -1
  219. package/types/player.d.tlua +288 -293
  220. package/types/player_manager.d.tlua +13 -14
  221. package/types/preseteditor.d.tlua +0 -1
  222. package/types/presets.d.tlua +6 -7
  223. package/types/projectedtexture.d.tlua +47 -49
  224. package/types/properties.d.tlua +5 -6
  225. package/types/propselect.d.tlua +3 -5
  226. package/types/radiobutton.d.tlua +0 -1
  227. package/types/render.d.tlua +142 -143
  228. package/types/resource.d.tlua +2 -3
  229. package/types/richtext.d.tlua +0 -1
  230. package/types/sandbox.d.tlua +52 -54
  231. package/types/saverestore.d.tlua +12 -13
  232. package/types/schedule.d.tlua +5 -7
  233. package/types/scripted_ents.d.tlua +9 -12
  234. package/types/search.d.tlua +1 -2
  235. package/types/serverlist.d.tlua +7 -8
  236. package/types/slidebar.d.tlua +0 -1
  237. package/types/slider.d.tlua +0 -1
  238. package/types/sound.d.tlua +10 -11
  239. package/types/spawnicon.d.tlua +6 -8
  240. package/types/spawnmenu.d.tlua +23 -25
  241. package/types/spawnmenucontentpanel.d.tlua +3 -5
  242. package/types/sql.d.tlua +9 -10
  243. package/types/stack.d.tlua +4 -6
  244. package/types/steamworks.d.tlua +18 -19
  245. package/types/string.d.tlua +46 -50
  246. package/types/structures.d.tlua +0 -7
  247. package/types/surface.d.tlua +34 -35
  248. package/types/surfaceinfo.d.tlua +4 -6
  249. package/types/system.d.tlua +10 -11
  250. package/types/table.d.tlua +45 -48
  251. package/types/task.d.tlua +8 -10
  252. package/types/team.d.tlua +19 -20
  253. package/types/textentry.d.tlua +0 -1
  254. package/types/tgaimage.d.tlua +0 -1
  255. package/types/timer.d.tlua +14 -15
  256. package/types/tool.d.tlua +42 -46
  257. package/types/ugcpublishwindow.d.tlua +7 -9
  258. package/types/umsg.d.tlua +12 -13
  259. package/types/undo.d.tlua +10 -11
  260. package/types/urllabel.d.tlua +0 -1
  261. package/types/usermessage.d.tlua +2 -3
  262. package/types/utf8.d.tlua +7 -8
  263. package/types/util.d.tlua +90 -95
  264. package/types/vector.d.tlua +36 -37
  265. package/types/vehicle.d.tlua +48 -51
  266. package/types/vgui.d.tlua +14 -19
  267. package/types/video.d.tlua +0 -1
  268. package/types/vmatrix.d.tlua +35 -36
  269. package/types/weapon.d.tlua +81 -84
  270. package/types/weapons.d.tlua +5 -7
  271. package/types/widgets.d.tlua +1 -2
  272. package/types/workshopfilebase.d.tlua +4 -6
@@ -19,12 +19,14 @@ interface PLAYER {
19
19
  * @source https://wiki.facepunch.com/gmod/PLAYER:ClassChanged
20
20
  */
21
21
  ClassChanged(self: PLAYER): void;
22
+
22
23
  /**
23
24
  * Called when the player dies
24
25
  * @realm server
25
26
  * @source https://wiki.facepunch.com/gmod/PLAYER:Death
26
27
  */
27
28
  Death(self: PLAYER): void;
29
+
28
30
  /**
29
31
  * Called from [GM:FinishMove](https://wiki.facepunch.com/gmod/GM:FinishMove).
30
32
  *
@@ -38,24 +40,28 @@ interface PLAYER {
38
40
  * @source https://wiki.facepunch.com/gmod/PLAYER:FinishMove
39
41
  */
40
42
  FinishMove(self: PLAYER, mv: CMoveData): boolean;
43
+
41
44
  /**
42
45
  * Called on player spawn to determine which hand model to use
43
46
  * @realm server
44
47
  * @source https://wiki.facepunch.com/gmod/PLAYER:GetHandsModel
45
48
  */
46
49
  GetHandsModel(self: PLAYER): table;
50
+
47
51
  /**
48
52
  * Called when the class object is created
49
53
  * @realm shared
50
54
  * @source https://wiki.facepunch.com/gmod/PLAYER:Init
51
55
  */
52
56
  Init(self: PLAYER): void;
57
+
53
58
  /**
54
59
  * Called on spawn to give the player their default loadout
55
60
  * @realm server
56
61
  * @source https://wiki.facepunch.com/gmod/PLAYER:Loadout
57
62
  */
58
63
  Loadout(self: PLAYER): void;
64
+
59
65
  /**
60
66
  * Called from [GM:Move](https://wiki.facepunch.com/gmod/GM:Move).
61
67
  *
@@ -69,18 +75,21 @@ interface PLAYER {
69
75
  * @source https://wiki.facepunch.com/gmod/PLAYER:Move
70
76
  */
71
77
  Move(self: PLAYER, mv: CMoveData): boolean;
78
+
72
79
  /**
73
80
  * Called after the viewmodel has been drawn
74
81
  * @realm client
75
82
  * @source https://wiki.facepunch.com/gmod/PLAYER:PostDrawViewModel
76
83
  */
77
84
  PostDrawViewModel(self: PLAYER, viewmodel: Entity, weapon: Entity): void;
85
+
78
86
  /**
79
87
  * Called before the viewmodel is drawn
80
88
  * @realm client
81
89
  * @source https://wiki.facepunch.com/gmod/PLAYER:PreDrawViewModel
82
90
  */
83
91
  PreDrawViewModel(self: PLAYER, viewmodel: Entity, weapon: Entity): void;
92
+
84
93
  /**
85
94
  * Called when we need to set player model from the class.
86
95
  *
@@ -91,18 +100,21 @@ interface PLAYER {
91
100
  * @source https://wiki.facepunch.com/gmod/PLAYER:SetModel
92
101
  */
93
102
  SetModel(self: PLAYER): void;
103
+
94
104
  /**
95
105
  * Setup the network table accessors.
96
106
  * @realm shared
97
107
  * @source https://wiki.facepunch.com/gmod/PLAYER:SetupDataTables
98
108
  */
99
109
  SetupDataTables(self: PLAYER): void;
110
+
100
111
  /**
101
112
  * Called when the player spawns
102
113
  * @realm server
103
114
  * @source https://wiki.facepunch.com/gmod/PLAYER:Spawn
104
115
  */
105
116
  Spawn(self: PLAYER): void;
117
+
106
118
  /**
107
119
  * Called from [GM:CreateMove](https://wiki.facepunch.com/gmod/GM:CreateMove).
108
120
  *
@@ -116,6 +128,7 @@ interface PLAYER {
116
128
  * @source https://wiki.facepunch.com/gmod/PLAYER:StartMove
117
129
  */
118
130
  StartMove(self: PLAYER, mv: CMoveData, cmd: CUserCmd): boolean;
131
+
119
132
  /**
120
133
  * Called when the player changes their weapon to another one causing their viewmodel model to change
121
134
  * @realm client
@@ -146,6 +159,7 @@ interface Player extends Entity {
146
159
  * @source https://wiki.facepunch.com/gmod/Player:AccountID
147
160
  */
148
161
  AccountID(self: Player): number;
162
+
149
163
  /**
150
164
  * **NOTE**: This function is only available in Sandbox and its derivatives.
151
165
  * Adds an entity to the player's clean up list. This uses [cleanup.Add](https://wiki.facepunch.com/gmod/cleanup.Add) internally.
@@ -153,6 +167,7 @@ interface Player extends Entity {
153
167
  * @source https://wiki.facepunch.com/gmod/Player:AddCleanup
154
168
  */
155
169
  AddCleanup(self: Player, type: string, ent: Entity): void;
170
+
156
171
  /**
157
172
  * **NOTE**: This function is only available in Sandbox and its derivatives.
158
173
  * Adds an entity to the player's list of entities of the same type. See [Player:GetCount](https://wiki.facepunch.com/gmod/Player:GetCount) to get the current count of entities of an entity type added with this function.
@@ -160,24 +175,28 @@ interface Player extends Entity {
160
175
  * @source https://wiki.facepunch.com/gmod/Player:AddCount
161
176
  */
162
177
  AddCount(self: Player, str: string, ent: Entity): void;
178
+
163
179
  /**
164
180
  * Adds the provided amount to the player's death count.
165
181
  * @realm server
166
182
  * @source https://wiki.facepunch.com/gmod/Player:AddDeaths
167
183
  */
168
184
  AddDeaths(self: Player, count: number): void;
185
+
169
186
  /**
170
187
  * Adds the provided amount to the player's frag/kill count.
171
188
  * @realm server
172
189
  * @source https://wiki.facepunch.com/gmod/Player:AddFrags
173
190
  */
174
191
  AddFrags(self: Player, count: number): void;
192
+
175
193
  /**
176
194
  * Adds an entity to the player's list of frozen objects.
177
195
  * @realm server
178
196
  * @source https://wiki.facepunch.com/gmod/Player:AddFrozenPhysicsObject
179
197
  */
180
198
  AddFrozenPhysicsObject(self: Player, ent: Entity, physobj: PhysObj): void;
199
+
181
200
  /**
182
201
  * Sets up the voting system for the player.
183
202
  * This is a really barebone system. By calling this a vote gets started, when the player presses 0-9 the callback function gets called along with the key the player pressed. Use the draw callback to draw the vote panel.
@@ -186,6 +205,7 @@ interface Player extends Entity {
186
205
  * @source https://wiki.facepunch.com/gmod/Player:AddPlayerOption
187
206
  */
188
207
  AddPlayerOption(self: Player, name: string, timeout: number, vote_callback: (voteNum: number) => boolean, draw_callback: function): void;
208
+
189
209
  /**
190
210
  * Plays a sequence directly from a sequence number, similar to [Player:AnimRestartGesture](https://wiki.facepunch.com/gmod/Player:AnimRestartGesture). This function has the advantage to play sequences that haven't been bound to an existing [Enums/ACT](https://wiki.facepunch.com/gmod/Enums/ACT)
191
211
  * **WARNING**: This is not automatically networked. This function has to be called on the client to be seen by said client.
@@ -195,6 +215,7 @@ interface Player extends Entity {
195
215
  * @source https://wiki.facepunch.com/gmod/Player:AddVCDSequenceToGestureSlot
196
216
  */
197
217
  AddVCDSequenceToGestureSlot(self: Player, slot: number, sequenceId: number, cycle: number, autokill?: boolean): void;
218
+
198
219
  /**
199
220
  * Sets if the player can toggle their flashlight. Function exists on both the server and client but has no effect when ran on the client.
200
221
  *
@@ -204,18 +225,21 @@ interface Player extends Entity {
204
225
  * @source https://wiki.facepunch.com/gmod/Player:AllowFlashlight
205
226
  */
206
227
  AllowFlashlight(self: Player, canFlashlight: boolean): void;
228
+
207
229
  /**
208
230
  * Lets the player spray their decal without delay
209
231
  * @realm server
210
232
  * @source https://wiki.facepunch.com/gmod/Player:AllowImmediateDecalPainting
211
233
  */
212
234
  AllowImmediateDecalPainting(self: Player, allow: boolean): void;
235
+
213
236
  /**
214
237
  * Resets player gesture in selected slot.
215
238
  * @realm shared
216
239
  * @source https://wiki.facepunch.com/gmod/Player:AnimResetGestureSlot
217
240
  */
218
241
  AnimResetGestureSlot(self: Player, slot: number): void;
242
+
219
243
  /**
220
244
  * Restart a gesture on a player, within a gesture slot.
221
245
  *
@@ -226,36 +250,42 @@ interface Player extends Entity {
226
250
  * @source https://wiki.facepunch.com/gmod/Player:AnimRestartGesture
227
251
  */
228
252
  AnimRestartGesture(self: Player, slot: number, activity: number, autokill?: boolean): void;
253
+
229
254
  /**
230
255
  * Restarts the main animation on the player, has the same effect as calling [Entity:SetCycle](https://wiki.facepunch.com/gmod/Entity:SetCycle)( 0 ).
231
256
  * @realm shared
232
257
  * @source https://wiki.facepunch.com/gmod/Player:AnimRestartMainSequence
233
258
  */
234
259
  AnimRestartMainSequence(self: Player): void;
260
+
235
261
  /**
236
262
  * Sets the sequence of the animation playing in the given gesture slot.
237
263
  * @realm shared
238
264
  * @source https://wiki.facepunch.com/gmod/Player:AnimSetGestureSequence
239
265
  */
240
266
  AnimSetGestureSequence(self: Player, slot: number, sequenceID: number): void;
267
+
241
268
  /**
242
269
  * Sets the weight of the animation playing in the given gesture slot.
243
270
  * @realm shared
244
271
  * @source https://wiki.facepunch.com/gmod/Player:AnimSetGestureWeight
245
272
  */
246
273
  AnimSetGestureWeight(self: Player, slot: number, weight: number): void;
274
+
247
275
  /**
248
276
  * Returns the player's armor.
249
277
  * @realm shared
250
278
  * @source https://wiki.facepunch.com/gmod/Player:Armor
251
279
  */
252
280
  Armor(self: Player): number;
281
+
253
282
  /**
254
283
  * Bans the player from the server for a certain amount of minutes.
255
284
  * @realm server
256
285
  * @source https://wiki.facepunch.com/gmod/Player:Ban
257
286
  */
258
287
  Ban(self: Player, minutes: number, kick?: boolean): void;
288
+
259
289
  /**
260
290
  * Returns true if the player's flashlight hasn't been disabled by [Player:AllowFlashlight](https://wiki.facepunch.com/gmod/Player:AllowFlashlight).
261
291
  *
@@ -266,6 +296,7 @@ interface Player extends Entity {
266
296
  * @source https://wiki.facepunch.com/gmod/Player:CanUseFlashlight
267
297
  */
268
298
  CanUseFlashlight(self: Player): boolean;
299
+
269
300
  /**
270
301
  * Prints a string to the chatbox of the client.
271
302
  *
@@ -276,6 +307,7 @@ interface Player extends Entity {
276
307
  * @source https://wiki.facepunch.com/gmod/Player:ChatPrint
277
308
  */
278
309
  ChatPrint(self: Player, message: string): void;
310
+
279
311
  /**
280
312
  * Checks if the limit of an entity type added by [Player:AddCount](https://wiki.facepunch.com/gmod/Player:AddCount) is hit or not. If it's hit, it will call the [GM:PlayerCheckLimit](https://wiki.facepunch.com/gmod/GM:PlayerCheckLimit) hook, and call [Player:LimitHit](https://wiki.facepunch.com/gmod/Player:LimitHit) if the hook doesn't return `false`.
281
313
  *
@@ -288,6 +320,7 @@ interface Player extends Entity {
288
320
  * @source https://wiki.facepunch.com/gmod/Player:CheckLimit
289
321
  */
290
322
  CheckLimit(self: Player, str: string): boolean;
323
+
291
324
  /**
292
325
  * Runs the concommand on the player. This does not work on bots. If used clientside, always runs the command on the local player.
293
326
  *
@@ -300,6 +333,7 @@ interface Player extends Entity {
300
333
  * @source https://wiki.facepunch.com/gmod/Player:ConCommand
301
334
  */
302
335
  ConCommand(self: Player, command: string): void;
336
+
303
337
  /**
304
338
  * Creates the player's death ragdoll entity and deletes the old one.
305
339
  *
@@ -313,48 +347,56 @@ interface Player extends Entity {
313
347
  * @source https://wiki.facepunch.com/gmod/Player:CreateRagdoll
314
348
  */
315
349
  CreateRagdoll(self: Player): void;
350
+
316
351
  /**
317
352
  * Disables the default player's crosshair. Can be reenabled with [Player:CrosshairEnable](https://wiki.facepunch.com/gmod/Player:CrosshairEnable). This will affect [WEAPON:DoDrawCrosshair](https://wiki.facepunch.com/gmod/WEAPON:DoDrawCrosshair).
318
353
  * @realm server
319
354
  * @source https://wiki.facepunch.com/gmod/Player:CrosshairDisable
320
355
  */
321
356
  CrosshairDisable(self: Player): void;
357
+
322
358
  /**
323
359
  * Enables the player's crosshair, if it was previously disabled via [Player:CrosshairDisable](https://wiki.facepunch.com/gmod/Player:CrosshairDisable).
324
360
  * @realm server
325
361
  * @source https://wiki.facepunch.com/gmod/Player:CrosshairEnable
326
362
  */
327
363
  CrosshairEnable(self: Player): void;
364
+
328
365
  /**
329
366
  * Returns whether the player is crouching or not ([FL_DUCKING](https://wiki.facepunch.com/gmod/Enums/FL) flag).
330
367
  * @realm shared
331
368
  * @source https://wiki.facepunch.com/gmod/Player:Crouching
332
369
  */
333
370
  Crouching(self: Player): boolean;
371
+
334
372
  /**
335
373
  * Returns the player's death count
336
374
  * @realm shared
337
375
  * @source https://wiki.facepunch.com/gmod/Player:Deaths
338
376
  */
339
377
  Deaths(self: Player): number;
378
+
340
379
  /**
341
380
  * Prints the players' name and position to the console.
342
381
  * @realm shared
343
382
  * @source https://wiki.facepunch.com/gmod/Player:DebugInfo
344
383
  */
345
384
  DebugInfo(self: Player): void;
385
+
346
386
  /**
347
387
  * Detonates all tripmines belonging to the player.
348
388
  * @realm server
349
389
  * @source https://wiki.facepunch.com/gmod/Player:DetonateTripmines
350
390
  */
351
391
  DetonateTripmines(self: Player): void;
392
+
352
393
  /**
353
394
  * Disables world clicking for given player. See [Panel:SetWorldClicker](https://wiki.facepunch.com/gmod/Panel:SetWorldClicker) and [Player:IsWorldClickingDisabled](https://wiki.facepunch.com/gmod/Player:IsWorldClickingDisabled).
354
395
  * @realm server
355
396
  * @source https://wiki.facepunch.com/gmod/Player:DisableWorldClicking
356
397
  */
357
398
  DisableWorldClicking(self: Player, disable: boolean): void;
399
+
358
400
  /**
359
401
  * Sends a third person animation event to the player.
360
402
  *
@@ -364,6 +406,7 @@ interface Player extends Entity {
364
406
  * @source https://wiki.facepunch.com/gmod/Player:DoAnimationEvent
365
407
  */
366
408
  DoAnimationEvent(self: Player, data: number): void;
409
+
367
410
  /**
368
411
  * Starts the player's attack animation. The attack animation is determined by the weapon's HoldType.
369
412
  *
@@ -373,6 +416,7 @@ interface Player extends Entity {
373
416
  * @source https://wiki.facepunch.com/gmod/Player:DoAttackEvent
374
417
  */
375
418
  DoAttackEvent(self: Player): void;
419
+
376
420
  /**
377
421
  * Sends a specified third person animation event to the player.
378
422
  *
@@ -382,6 +426,7 @@ interface Player extends Entity {
382
426
  * @source https://wiki.facepunch.com/gmod/Player:DoCustomAnimEvent
383
427
  */
384
428
  DoCustomAnimEvent(self: Player, event: number, data: number): void;
429
+
385
430
  /**
386
431
  * Sends a third person reload animation event to the player.
387
432
  *
@@ -391,6 +436,7 @@ interface Player extends Entity {
391
436
  * @source https://wiki.facepunch.com/gmod/Player:DoReloadEvent
392
437
  */
393
438
  DoReloadEvent(self: Player): void;
439
+
394
440
  /**
395
441
  * Sends a third person secondary fire animation event to the player.
396
442
  *
@@ -400,24 +446,28 @@ interface Player extends Entity {
400
446
  * @source https://wiki.facepunch.com/gmod/Player:DoSecondaryAttack
401
447
  */
402
448
  DoSecondaryAttack(self: Player): void;
449
+
403
450
  /**
404
451
  * Show/Hide the player's weapon's viewmodel.
405
452
  * @realm shared
406
453
  * @source https://wiki.facepunch.com/gmod/Player:DrawViewModel
407
454
  */
408
455
  DrawViewModel(self: Player, draw: boolean, vm?: number): void;
456
+
409
457
  /**
410
458
  * Show/Hide the player's weapon's worldmodel.
411
459
  * @realm server
412
460
  * @source https://wiki.facepunch.com/gmod/Player:DrawWorldModel
413
461
  */
414
462
  DrawWorldModel(self: Player, draw: boolean): void;
463
+
415
464
  /**
416
465
  * Drops the players' weapon of a specific class.
417
466
  * @realm server
418
467
  * @source https://wiki.facepunch.com/gmod/Player:DropNamedWeapon
419
468
  */
420
469
  DropNamedWeapon(self: Player, _class: string, target?: Vector, velocity?: Vector): void;
470
+
421
471
  /**
422
472
  * Drops any object the player is currently holding with either Gravity Gun, Physics Gun or `+use` (E key)
423
473
  *
@@ -427,12 +477,14 @@ interface Player extends Entity {
427
477
  * @source https://wiki.facepunch.com/gmod/Player:DropObject
428
478
  */
429
479
  DropObject(self: Player, entity?: Entity): void;
480
+
430
481
  /**
431
482
  * Forces the player to drop the specified weapon
432
483
  * @realm server
433
484
  * @source https://wiki.facepunch.com/gmod/Player:DropWeapon
434
485
  */
435
486
  DropWeapon(self: Player, weapon?: Weapon, target?: Vector, velocity?: Vector): void;
487
+
436
488
  /**
437
489
  * Force puts the player into a specified vehicle.
438
490
  * This **does not** bypass [GM:CanPlayerEnterVehicle](https://wiki.facepunch.com/gmod/GM:CanPlayerEnterVehicle).
@@ -441,6 +493,7 @@ interface Player extends Entity {
441
493
  * @source https://wiki.facepunch.com/gmod/Player:EnterVehicle
442
494
  */
443
495
  EnterVehicle(self: Player, vehicle: Vehicle): void;
496
+
444
497
  /**
445
498
  * Equips the player with the HEV suit.
446
499
  *
@@ -453,12 +506,14 @@ interface Player extends Entity {
453
506
  * @source https://wiki.facepunch.com/gmod/Player:EquipSuit
454
507
  */
455
508
  EquipSuit(self: Player): void;
509
+
456
510
  /**
457
511
  * Forces the player off the current ladder if they are on one.
458
512
  * @realm server
459
513
  * @source https://wiki.facepunch.com/gmod/Player:ExitLadder
460
514
  */
461
515
  ExitLadder(self: Player): void;
516
+
462
517
  /**
463
518
  * Forces the player to exit the vehicle if they're in one.
464
519
  *
@@ -468,6 +523,7 @@ interface Player extends Entity {
468
523
  * @source https://wiki.facepunch.com/gmod/Player:ExitVehicle
469
524
  */
470
525
  ExitVehicle(self: Player): void;
526
+
471
527
  /**
472
528
  * Enables/Disables the player's flashlight.
473
529
  *
@@ -484,12 +540,14 @@ interface Player extends Entity {
484
540
  * @source https://wiki.facepunch.com/gmod/Player:Flashlight
485
541
  */
486
542
  Flashlight(self: Player, isOn: boolean): void;
543
+
487
544
  /**
488
545
  * Returns true if the player's flashlight is on.
489
546
  * @realm shared
490
547
  * @source https://wiki.facepunch.com/gmod/Player:FlashlightIsOn
491
548
  */
492
549
  FlashlightIsOn(self: Player): boolean;
550
+
493
551
  /**
494
552
  * Returns the amount of frags a player has.
495
553
  *
@@ -500,6 +558,7 @@ interface Player extends Entity {
500
558
  * @source https://wiki.facepunch.com/gmod/Player:Frags
501
559
  */
502
560
  Frags(self: Player): number;
561
+
503
562
  /**
504
563
  * Freeze the player. Frozen players cannot move, look around, or attack. Key bindings are still called. Similar to [Player:Lock](https://wiki.facepunch.com/gmod/Player:Lock) but the player can still take damage.
505
564
  *
@@ -510,6 +569,7 @@ interface Player extends Entity {
510
569
  * @source https://wiki.facepunch.com/gmod/Player:Freeze
511
570
  */
512
571
  Freeze(self: Player, frozen?: boolean): void;
572
+
513
573
  /**
514
574
  * Returns the player's active weapon.
515
575
  *
@@ -519,66 +579,77 @@ interface Player extends Entity {
519
579
  * @source https://wiki.facepunch.com/gmod/Player:GetActiveWeapon
520
580
  */
521
581
  GetActiveWeapon(self: Player): Weapon;
582
+
522
583
  /**
523
584
  * Returns the player's current activity.
524
585
  * @realm server
525
586
  * @source https://wiki.facepunch.com/gmod/Player:GetActivity
526
587
  */
527
588
  GetActivity(self: Player): number;
589
+
528
590
  /**
529
591
  * Returns the direction that the player is aiming.
530
592
  * @realm shared
531
593
  * @source https://wiki.facepunch.com/gmod/Player:GetAimVector
532
594
  */
533
595
  GetAimVector(self: Player): Vector;
596
+
534
597
  /**
535
598
  * Returns true if the players' model is allowed to rotate around the pitch and roll axis.
536
599
  * @realm shared
537
600
  * @source https://wiki.facepunch.com/gmod/Player:GetAllowFullRotation
538
601
  */
539
602
  GetAllowFullRotation(self: Player): boolean;
603
+
540
604
  /**
541
605
  * Returns whether the player is allowed to use their weapons in a vehicle or not.
542
606
  * @realm shared
543
607
  * @source https://wiki.facepunch.com/gmod/Player:GetAllowWeaponsInVehicle
544
608
  */
545
609
  GetAllowWeaponsInVehicle(self: Player): boolean;
610
+
546
611
  /**
547
612
  * Returns a table of all ammo the player has.
548
613
  * @realm shared
549
614
  * @source https://wiki.facepunch.com/gmod/Player:GetAmmo
550
615
  */
551
616
  GetAmmo(self: Player): table;
617
+
552
618
  /**
553
619
  * Gets the amount of ammo the player has.
554
620
  * @realm shared
555
621
  * @source https://wiki.facepunch.com/gmod/Player:GetAmmoCount
556
622
  */
557
623
  GetAmmoCount(self: Player, ammotype: any): number;
624
+
558
625
  /**
559
626
  * Gets if the player will be pushed out of nocollided players.
560
627
  * @realm shared
561
628
  * @source https://wiki.facepunch.com/gmod/Player:GetAvoidPlayers
562
629
  */
563
630
  GetAvoidPlayers(self: Player): boolean;
631
+
564
632
  /**
565
633
  * Returns true if the player is able to walk using the (default) alt key.
566
634
  * @realm shared
567
635
  * @source https://wiki.facepunch.com/gmod/Player:GetCanWalk
568
636
  */
569
637
  GetCanWalk(self: Player): boolean;
638
+
570
639
  /**
571
640
  * Determines whenever the player is allowed to use the zoom functionality.
572
641
  * @realm shared
573
642
  * @source https://wiki.facepunch.com/gmod/Player:GetCanZoom
574
643
  */
575
644
  GetCanZoom(self: Player): boolean;
645
+
576
646
  /**
577
647
  * Returns the player's class id.
578
648
  * @realm shared
579
649
  * @source https://wiki.facepunch.com/gmod/Player:GetClassID
580
650
  */
581
651
  GetClassID(self: Player): number;
652
+
582
653
  /**
583
654
  * **NOTE**: This function is only available in Sandbox and its derivatives.
584
655
  * Gets the total amount of entities of an entity type added by [Player:AddCount](https://wiki.facepunch.com/gmod/Player:AddCount).
@@ -606,6 +677,7 @@ interface Player extends Entity {
606
677
  * @source https://wiki.facepunch.com/gmod/Player:GetCount
607
678
  */
608
679
  GetCount(self: Player, type: string, minus?: number): number;
680
+
609
681
  /**
610
682
  * Returns the crouched walk speed multiplier.
611
683
  *
@@ -615,6 +687,7 @@ interface Player extends Entity {
615
687
  * @source https://wiki.facepunch.com/gmod/Player:GetCrouchedWalkSpeed
616
688
  */
617
689
  GetCrouchedWalkSpeed(self: Player): number;
690
+
618
691
  /**
619
692
  * Returns the last command which was sent by the specified player. This can only be called on the player which [Global.GetPredictionPlayer](https://wiki.facepunch.com/gmod/Global.GetPredictionPlayer)() returns.
620
693
  *
@@ -627,6 +700,7 @@ interface Player extends Entity {
627
700
  * @source https://wiki.facepunch.com/gmod/Player:GetCurrentCommand
628
701
  */
629
702
  GetCurrentCommand(self: Player): CUserCmd;
703
+
630
704
  /**
631
705
  * Gets the current applied view offset, which transitions between the player's standing and ducked view offset depending on their duck state.
632
706
  *
@@ -636,30 +710,35 @@ interface Player extends Entity {
636
710
  * @source https://wiki.facepunch.com/gmod/Player:GetCurrentViewOffset
637
711
  */
638
712
  GetCurrentViewOffset(self: Player): Vector;
713
+
639
714
  /**
640
715
  * Gets the entity the player is currently driving via the [drive](https://wiki.facepunch.com/gmod/drive) library.
641
716
  * @realm shared
642
717
  * @source https://wiki.facepunch.com/gmod/Player:GetDrivingEntity
643
718
  */
644
719
  GetDrivingEntity(self: Player): Entity;
720
+
645
721
  /**
646
722
  * Returns driving mode of the player. See [Entity Driving](https://wiki.facepunch.com/gmod/Entity_Driving).
647
723
  * @realm shared
648
724
  * @source https://wiki.facepunch.com/gmod/Player:GetDrivingMode
649
725
  */
650
726
  GetDrivingMode(self: Player): number;
727
+
651
728
  /**
652
729
  * Returns a player's duck speed (in seconds)
653
730
  * @realm shared
654
731
  * @source https://wiki.facepunch.com/gmod/Player:GetDuckSpeed
655
732
  */
656
733
  GetDuckSpeed(self: Player): number;
734
+
657
735
  /**
658
736
  * Returns the entity the player is currently using, like func_tank mounted turrets or +use prop pickups.
659
737
  * @realm shared
660
738
  * @source https://wiki.facepunch.com/gmod/Player:GetEntityInUse
661
739
  */
662
740
  GetEntityInUse(self: Player): Entity;
741
+
663
742
  /**
664
743
  * Returns a table with information of what the player is looking at.
665
744
  *
@@ -673,6 +752,7 @@ interface Player extends Entity {
673
752
  * @source https://wiki.facepunch.com/gmod/Player:GetEyeTrace
674
753
  */
675
754
  GetEyeTrace(self: Player): TraceResult;
755
+
676
756
  /**
677
757
  * Returns the trace according to the players view direction, ignoring their mouse (holding C and moving the mouse in Sandbox).
678
758
  *
@@ -686,12 +766,14 @@ interface Player extends Entity {
686
766
  * @source https://wiki.facepunch.com/gmod/Player:GetEyeTraceNoCursor
687
767
  */
688
768
  GetEyeTraceNoCursor(self: Player): TraceResult;
769
+
689
770
  /**
690
771
  * Returns the FOV of the player.
691
772
  * @realm shared
692
773
  * @source https://wiki.facepunch.com/gmod/Player:GetFOV
693
774
  */
694
775
  GetFOV(self: Player): number;
776
+
695
777
  /**
696
778
  * Returns the color of a player's flashlight.
697
779
  *
@@ -699,24 +781,28 @@ interface Player extends Entity {
699
781
  * @source https://wiki.facepunch.com/gmod/Player:GetFlashlightColor
700
782
  */
701
783
  GetFlashlightColor(self: Player): Color;
784
+
702
785
  /**
703
786
  * Returns the steam "relationship" towards the player.
704
787
  * @realm client
705
788
  * @source https://wiki.facepunch.com/gmod/Player:GetFriendStatus
706
789
  */
707
790
  GetFriendStatus(self: Player): string;
791
+
708
792
  /**
709
793
  * Gets the hands entity of a player
710
794
  * @realm shared
711
795
  * @source https://wiki.facepunch.com/gmod/Player:GetHands
712
796
  */
713
797
  GetHands(self: Player): Entity;
798
+
714
799
  /**
715
800
  * Returns the widget the player is hovering with their mouse.
716
801
  * @realm shared
717
802
  * @source https://wiki.facepunch.com/gmod/Player:GetHoveredWidget
718
803
  */
719
804
  GetHoveredWidget(self: Player): Entity;
805
+
720
806
  /**
721
807
  * Retrieves the minimum and maximum [Vectors](https://wiki.facepunch.com/gmod/Vector) of the [Axis-Aligned Bounding Box (AABB)](https://en.wikipedia.org/wiki/Minimum_bounding_box) used for the [Player's](https://wiki.facepunch.com/gmod/Player) physics and movement [Hull Traces](https://wiki.facepunch.com/gmod/util.TraceHull).
722
808
  *
@@ -726,6 +812,7 @@ interface Player extends Entity {
726
812
  * @source https://wiki.facepunch.com/gmod/Player:GetHull
727
813
  */
728
814
  GetHull(self: Player): (Vector, Vector);
815
+
729
816
  /**
730
817
  * Retrieves the minimum and maximum [Vectors](https://wiki.facepunch.com/gmod/Vector) of the [Axis-Aligned Bounding Box (AABB)](https://en.wikipedia.org/wiki/Minimum_bounding_box) used for the [Player's](https://wiki.facepunch.com/gmod/Player) physics and movement [Hull Traces](https://wiki.facepunch.com/gmod/util.TraceHull) while they are crouching (or "Ducking").
731
818
  *
@@ -735,6 +822,7 @@ interface Player extends Entity {
735
822
  * @source https://wiki.facepunch.com/gmod/Player:GetHullDuck
736
823
  */
737
824
  GetHullDuck(self: Player): (Vector, Vector);
825
+
738
826
  /**
739
827
  * Retrieves the value of a client-side [ConVar](https://wiki.facepunch.com/gmod/ConVar). The [ConVar](https://wiki.facepunch.com/gmod/ConVar) must have a [FCVAR_USERINFO](https://wiki.facepunch.com/gmod/Enums/FCVAR) flag for this to work.
740
828
  *
@@ -746,18 +834,21 @@ interface Player extends Entity {
746
834
  * @source https://wiki.facepunch.com/gmod/Player:GetInfo
747
835
  */
748
836
  GetInfo(self: Player, cVarName: string): string;
837
+
749
838
  /**
750
839
  * Retrieves the numeric value of a client-side convar, returns nil if value is not convertible to a number. The [ConVar](https://wiki.facepunch.com/gmod/ConVar) must have a [FCVAR_USERINFO](https://wiki.facepunch.com/gmod/Enums/FCVAR) flag for this to work.
751
840
  * @realm shared
752
841
  * @source https://wiki.facepunch.com/gmod/Player:GetInfoNum
753
842
  */
754
843
  GetInfoNum(self: Player, cVarName: string, _default: number): number;
844
+
755
845
  /**
756
846
  * Returns the jump power of the player
757
847
  * @realm shared
758
848
  * @source https://wiki.facepunch.com/gmod/Player:GetJumpPower
759
849
  */
760
850
  GetJumpPower(self: Player): number;
851
+
761
852
  /**
762
853
  * Returns the player's ladder climbing speed.
763
854
  *
@@ -767,12 +858,14 @@ interface Player extends Entity {
767
858
  * @source https://wiki.facepunch.com/gmod/Player:GetLadderClimbSpeed
768
859
  */
769
860
  GetLadderClimbSpeed(self: Player): number;
861
+
770
862
  /**
771
863
  * Returns the timescale multiplier of the player movement.
772
864
  * @realm shared
773
865
  * @source https://wiki.facepunch.com/gmod/Player:GetLaggedMovementValue
774
866
  */
775
867
  GetLaggedMovementValue(self: Player): number;
868
+
776
869
  /**
777
870
  * Returns the maximum amount of armor the player should have. Default value is 100.
778
871
  *
@@ -780,6 +873,7 @@ interface Player extends Entity {
780
873
  * @source https://wiki.facepunch.com/gmod/Player:GetMaxArmor
781
874
  */
782
875
  GetMaxArmor(self: Player): number;
876
+
783
877
  /**
784
878
  * Returns the player's maximum movement speed.
785
879
  *
@@ -789,18 +883,21 @@ interface Player extends Entity {
789
883
  * @source https://wiki.facepunch.com/gmod/Player:GetMaxSpeed
790
884
  */
791
885
  GetMaxSpeed(self: Player): number;
886
+
792
887
  /**
793
888
  * Returns whenever the player is set not to collide with their teammates.
794
889
  * @realm shared
795
890
  * @source https://wiki.facepunch.com/gmod/Player:GetNoCollideWithTeammates
796
891
  */
797
892
  GetNoCollideWithTeammates(self: Player): boolean;
893
+
798
894
  /**
799
895
  * Returns the the observer mode of the player
800
896
  * @realm shared
801
897
  * @source https://wiki.facepunch.com/gmod/Player:GetObserverMode
802
898
  */
803
899
  GetObserverMode(self: Player): number;
900
+
804
901
  /**
805
902
  * Returns the entity the player is currently observing.
806
903
  *
@@ -810,6 +907,7 @@ interface Player extends Entity {
810
907
  * @source https://wiki.facepunch.com/gmod/Player:GetObserverTarget
811
908
  */
812
909
  GetObserverTarget(self: Player): Entity;
910
+
813
911
  /**
814
912
  * Returns a **P**ersistent **Data** key-value pair from the SQL database. (`sv.db` when called on server, `cl.db` when called on client)
815
913
  *
@@ -825,6 +923,7 @@ interface Player extends Entity {
825
923
  * @source https://wiki.facepunch.com/gmod/Player:GetPData
826
924
  */
827
925
  GetPData(self: Player, key: string, _default?: any): string;
926
+
828
927
  /**
829
928
  * Returns a player's character model color.
830
929
  *
@@ -839,12 +938,14 @@ interface Player extends Entity {
839
938
  * @source https://wiki.facepunch.com/gmod/Player:GetPlayerColor
840
939
  */
841
940
  GetPlayerColor(self: Player): Vector;
941
+
842
942
  /**
843
943
  * Returns a table containing player information.
844
944
  * @realm shared
845
945
  * @source https://wiki.facepunch.com/gmod/Player:GetPlayerInfo
846
946
  */
847
947
  GetPlayerInfo(self: Player): table;
948
+
848
949
  /**
849
950
  * Returns the widget entity the player is using.
850
951
  *
@@ -854,12 +955,14 @@ interface Player extends Entity {
854
955
  * @source https://wiki.facepunch.com/gmod/Player:GetPressedWidget
855
956
  */
856
957
  GetPressedWidget(self: Player): Entity;
958
+
857
959
  /**
858
960
  * Returns the weapon the player previously had equipped.
859
961
  * @realm shared
860
962
  * @source https://wiki.facepunch.com/gmod/Player:GetPreviousWeapon
861
963
  */
862
964
  GetPreviousWeapon(self: Player): Entity;
965
+
863
966
  /**
864
967
  * Returns players screen punch effect angle. See [Player:ViewPunch](https://wiki.facepunch.com/gmod/Player:ViewPunch) and [Player:SetViewPunchAngles](https://wiki.facepunch.com/gmod/Player:SetViewPunchAngles)
865
968
  *
@@ -869,6 +972,7 @@ interface Player extends Entity {
869
972
  * @deprecated You should use Player:GetViewPunchAngles instead.
870
973
  */
871
974
  GetPunchAngle(self: Player): Angle;
975
+
872
976
  /**
873
977
  * Returns players death ragdoll. The ragdoll is created by [Player:CreateRagdoll](https://wiki.facepunch.com/gmod/Player:CreateRagdoll).
874
978
  * **NOTE**: Calling [Entity:GetPos](https://wiki.facepunch.com/gmod/Entity:GetPos) server-side with this function then will return the position where [Player:CreateRagdoll](https://wiki.facepunch.com/gmod/Player:CreateRagdoll) was used, as it is a hl2mp_ragdoll which is a serverside point entity that creates a clientside ragdoll for everyone (opposed to prop_ragdoll that is serverside and networks).
@@ -878,6 +982,7 @@ interface Player extends Entity {
878
982
  * @source https://wiki.facepunch.com/gmod/Player:GetRagdollEntity
879
983
  */
880
984
  GetRagdollEntity(self: Player): Entity;
985
+
881
986
  /**
882
987
  * Returns the player's sprint speed.
883
988
  *
@@ -887,6 +992,7 @@ interface Player extends Entity {
887
992
  * @source https://wiki.facepunch.com/gmod/Player:GetRunSpeed
888
993
  */
889
994
  GetRunSpeed(self: Player): number;
995
+
890
996
  /**
891
997
  * Returns the position of a Player's view
892
998
  *
@@ -897,6 +1003,7 @@ interface Player extends Entity {
897
1003
  * @source https://wiki.facepunch.com/gmod/Player:GetShootPos
898
1004
  */
899
1005
  GetShootPos(self: Player): Vector;
1006
+
900
1007
  /**
901
1008
  * Returns the player's slow walking speed, which is activated via +WALK keybind.
902
1009
  *
@@ -906,12 +1013,14 @@ interface Player extends Entity {
906
1013
  * @source https://wiki.facepunch.com/gmod/Player:GetSlowWalkSpeed
907
1014
  */
908
1015
  GetSlowWalkSpeed(self: Player): number;
1016
+
909
1017
  /**
910
1018
  * Returns the maximum height player can step onto.
911
1019
  * @realm shared
912
1020
  * @source https://wiki.facepunch.com/gmod/Player:GetStepSize
913
1021
  */
914
1022
  GetStepSize(self: Player): number;
1023
+
915
1024
  /**
916
1025
  * Returns the player's HEV suit power.
917
1026
  *
@@ -921,6 +1030,7 @@ interface Player extends Entity {
921
1030
  * @source https://wiki.facepunch.com/gmod/Player:GetSuitPower
922
1031
  */
923
1032
  GetSuitPower(self: Player): number;
1033
+
924
1034
  /**
925
1035
  * Returns the number of seconds that the player has been timing out for. You can check if a player is timing out with [Player:IsTimingOut](https://wiki.facepunch.com/gmod/Player:IsTimingOut).
926
1036
  *
@@ -930,18 +1040,21 @@ interface Player extends Entity {
930
1040
  * @source https://wiki.facepunch.com/gmod/Player:GetTimeoutSeconds
931
1041
  */
932
1042
  GetTimeoutSeconds(self: Player): number;
1043
+
933
1044
  /**
934
1045
  * Returns [TOOL](https://wiki.facepunch.com/gmod/Structures/TOOL) table of players current tool, or of the one specified.
935
1046
  * @realm shared
936
1047
  * @source https://wiki.facepunch.com/gmod/Player:GetTool
937
1048
  */
938
1049
  GetTool(self: Player, mode?: string): table;
1050
+
939
1051
  /**
940
1052
  * Returns a player's unduck speed (in seconds)
941
1053
  * @realm shared
942
1054
  * @source https://wiki.facepunch.com/gmod/Player:GetUnDuckSpeed
943
1055
  */
944
1056
  GetUnDuckSpeed(self: Player): number;
1057
+
945
1058
  /**
946
1059
  * Returns the entity the player would use if they would press their `+use` keybind.
947
1060
  * **NOTE**: Because entity physics objects usually do not exist on the client, the client's use entity will resolve to whatever the crosshair is placed on within a little less than 72 units of the player's eye position. This differs from the entity returned by the server, which has fully physical use checking. See [util.TraceHull](https://wiki.facepunch.com/gmod/util.TraceHull).
@@ -953,18 +1066,21 @@ interface Player extends Entity {
953
1066
  * @source https://wiki.facepunch.com/gmod/Player:GetUseEntity
954
1067
  */
955
1068
  GetUseEntity(self: Player): Entity;
1069
+
956
1070
  /**
957
1071
  * Returns the player's user group. By default, player user groups are loaded from `garrysmod/settings/users.txt`.
958
1072
  * @realm shared
959
1073
  * @source https://wiki.facepunch.com/gmod/Player:GetUserGroup
960
1074
  */
961
1075
  GetUserGroup(self: Player): string;
1076
+
962
1077
  /**
963
1078
  * Returns the vehicle the player is driving.
964
1079
  * @realm shared
965
1080
  * @source https://wiki.facepunch.com/gmod/Player:GetVehicle
966
1081
  */
967
1082
  GetVehicle(self: Player): Vehicle;
1083
+
968
1084
  /**
969
1085
  * Returns the entity the player is using to see from (such as the player itself, the camera, or another entity).
970
1086
  *
@@ -977,6 +1093,7 @@ interface Player extends Entity {
977
1093
  * @source https://wiki.facepunch.com/gmod/Player:GetViewEntity
978
1094
  */
979
1095
  GetViewEntity(self: Player): Entity;
1096
+
980
1097
  /**
981
1098
  * Returns the player's view model entity by the index.
982
1099
  * Each player has 3 view models by default, but only the first one is used.
@@ -990,6 +1107,7 @@ interface Player extends Entity {
990
1107
  * @source https://wiki.facepunch.com/gmod/Player:GetViewModel
991
1108
  */
992
1109
  GetViewModel(self: Player, index?: number): Entity;
1110
+
993
1111
  /**
994
1112
  * Returns the view offset of the player, which equals the difference between the player's actual position and their view when standing.
995
1113
  *
@@ -999,6 +1117,7 @@ interface Player extends Entity {
999
1117
  * @source https://wiki.facepunch.com/gmod/Player:GetViewOffset
1000
1118
  */
1001
1119
  GetViewOffset(self: Player): Vector;
1120
+
1002
1121
  /**
1003
1122
  * Returns the ducked view offset of the player, which equals the difference between the player's actual position and their view when ducked.
1004
1123
  *
@@ -1008,24 +1127,28 @@ interface Player extends Entity {
1008
1127
  * @source https://wiki.facepunch.com/gmod/Player:GetViewOffsetDucked
1009
1128
  */
1010
1129
  GetViewOffsetDucked(self: Player): Vector;
1130
+
1011
1131
  /**
1012
1132
  * Returns players screen punch effect angle.
1013
1133
  * @realm shared
1014
1134
  * @source https://wiki.facepunch.com/gmod/Player:GetViewPunchAngles
1015
1135
  */
1016
1136
  GetViewPunchAngles(self: Player): Angle;
1137
+
1017
1138
  /**
1018
1139
  * Returns client's view punch velocity. See [Player:ViewPunch](https://wiki.facepunch.com/gmod/Player:ViewPunch) and [Player:SetViewPunchVelocity](https://wiki.facepunch.com/gmod/Player:SetViewPunchVelocity)
1019
1140
  * @realm shared
1020
1141
  * @source https://wiki.facepunch.com/gmod/Player:GetViewPunchVelocity
1021
1142
  */
1022
1143
  GetViewPunchVelocity(self: Player): Angle;
1144
+
1023
1145
  /**
1024
1146
  * Returns the current voice volume scale for given player on client.
1025
1147
  * @realm client
1026
1148
  * @source https://wiki.facepunch.com/gmod/Player:GetVoiceVolumeScale
1027
1149
  */
1028
1150
  GetVoiceVolumeScale(self: Player): number;
1151
+
1029
1152
  /**
1030
1153
  * Returns the player's normal walking speed. Not sprinting, not slow walking. (+walk)
1031
1154
  *
@@ -1035,12 +1158,14 @@ interface Player extends Entity {
1035
1158
  * @source https://wiki.facepunch.com/gmod/Player:GetWalkSpeed
1036
1159
  */
1037
1160
  GetWalkSpeed(self: Player): number;
1161
+
1038
1162
  /**
1039
1163
  * Returns the weapon for the specified class
1040
1164
  * @realm shared
1041
1165
  * @source https://wiki.facepunch.com/gmod/Player:GetWeapon
1042
1166
  */
1043
1167
  GetWeapon(self: Player, className: string): Weapon;
1168
+
1044
1169
  /**
1045
1170
  * Returns a player's weapon color.
1046
1171
  *
@@ -1052,6 +1177,7 @@ interface Player extends Entity {
1052
1177
  * @source https://wiki.facepunch.com/gmod/Player:GetWeaponColor
1053
1178
  */
1054
1179
  GetWeaponColor(self: Player): Vector;
1180
+
1055
1181
  /**
1056
1182
  * Returns a table of the player's weapons.
1057
1183
  * **NOTE**: This function returns a sequential table. Prefer to loop it with [Global.ipairs](https://wiki.facepunch.com/gmod/Global.ipairs) instead of the [Global.pairs](https://wiki.facepunch.com/gmod/Global.pairs) function.
@@ -1061,6 +1187,7 @@ interface Player extends Entity {
1061
1187
  * @source https://wiki.facepunch.com/gmod/Player:GetWeapons
1062
1188
  */
1063
1189
  GetWeapons(self: Player): table;
1190
+
1064
1191
  /**
1065
1192
  * Gives the player a weapon.
1066
1193
  *
@@ -1073,24 +1200,28 @@ interface Player extends Entity {
1073
1200
  * @source https://wiki.facepunch.com/gmod/Player:Give
1074
1201
  */
1075
1202
  Give(self: Player, weaponClassName: string, bNoAmmo?: boolean): Weapon;
1203
+
1076
1204
  /**
1077
1205
  * Gives ammo to a player
1078
1206
  * @realm server
1079
1207
  * @source https://wiki.facepunch.com/gmod/Player:GiveAmmo
1080
1208
  */
1081
1209
  GiveAmmo(self: Player, amount: number, type: string | number, hidePopup?: boolean): number;
1210
+
1082
1211
  /**
1083
1212
  * Disables god mode on the player. Removes the [FL_GODMODE](https://wiki.facepunch.com/gmod/Enums/FL#FL_GODMODE) flag from the player.
1084
1213
  * @realm server
1085
1214
  * @source https://wiki.facepunch.com/gmod/Player:GodDisable
1086
1215
  */
1087
1216
  GodDisable(self: Player): void;
1217
+
1088
1218
  /**
1089
1219
  * Enables god mode on the player. Adds the [FL_GODMODE](https://wiki.facepunch.com/gmod/Enums/FL#FL_GODMODE) flag to the player.
1090
1220
  * @realm server
1091
1221
  * @source https://wiki.facepunch.com/gmod/Player:GodEnable
1092
1222
  */
1093
1223
  GodEnable(self: Player): void;
1224
+
1094
1225
  /**
1095
1226
  * Returns whether the player has god mode or not, contolled by [Player:GodEnable](https://wiki.facepunch.com/gmod/Player:GodEnable) and [Player:GodDisable](https://wiki.facepunch.com/gmod/Player:GodDisable).
1096
1227
  *
@@ -1098,12 +1229,14 @@ interface Player extends Entity {
1098
1229
  * @source https://wiki.facepunch.com/gmod/Player:HasGodMode
1099
1230
  */
1100
1231
  HasGodMode(self: Player): boolean;
1232
+
1101
1233
  /**
1102
1234
  * Returns if the player has the specified weapon
1103
1235
  * @realm shared
1104
1236
  * @source https://wiki.facepunch.com/gmod/Player:HasWeapon
1105
1237
  */
1106
1238
  HasWeapon(self: Player, className: string): boolean;
1239
+
1107
1240
  /**
1108
1241
  * Returns the player's IP address and connection port in ip:port form
1109
1242
  * **NOTE**: Returns `Error!` for bots.
@@ -1112,12 +1245,14 @@ interface Player extends Entity {
1112
1245
  * @source https://wiki.facepunch.com/gmod/Player:IPAddress
1113
1246
  */
1114
1247
  IPAddress(self: Player): string;
1248
+
1115
1249
  /**
1116
1250
  * Returns if the player is in a vehicle
1117
1251
  * @realm shared
1118
1252
  * @source https://wiki.facepunch.com/gmod/Player:InVehicle
1119
1253
  */
1120
1254
  InVehicle(self: Player): boolean;
1255
+
1121
1256
  /**
1122
1257
  * Returns whether the player is an admin or not. It will also return `true` if the player is [Player:IsSuperAdmin](https://wiki.facepunch.com/gmod/Player:IsSuperAdmin) by default.
1123
1258
  *
@@ -1127,30 +1262,35 @@ interface Player extends Entity {
1127
1262
  * @source https://wiki.facepunch.com/gmod/Player:IsAdmin
1128
1263
  */
1129
1264
  IsAdmin(self: Player): boolean;
1265
+
1130
1266
  /**
1131
1267
  * Returns if the player is an bot or not
1132
1268
  * @realm shared
1133
1269
  * @source https://wiki.facepunch.com/gmod/Player:IsBot
1134
1270
  */
1135
1271
  IsBot(self: Player): boolean;
1272
+
1136
1273
  /**
1137
1274
  * Returns true from the point when the player is sending client info but not fully in the game until they disconnect.
1138
1275
  * @realm server
1139
1276
  * @source https://wiki.facepunch.com/gmod/Player:IsConnected
1140
1277
  */
1141
1278
  IsConnected(self: Player): boolean;
1279
+
1142
1280
  /**
1143
1281
  * Used to find out if a player is currently 'driving' an entity (by which we mean 'right click > drive' ).
1144
1282
  * @realm shared
1145
1283
  * @source https://wiki.facepunch.com/gmod/Player:IsDrivingEntity
1146
1284
  */
1147
1285
  IsDrivingEntity(self: Player): boolean;
1286
+
1148
1287
  /**
1149
1288
  * Returns whether the players movement is currently frozen, controlled by [Player:Freeze](https://wiki.facepunch.com/gmod/Player:Freeze).
1150
1289
  * @realm shared
1151
1290
  * @source https://wiki.facepunch.com/gmod/Player:IsFrozen
1152
1291
  */
1153
1292
  IsFrozen(self: Player): boolean;
1293
+
1154
1294
  /**
1155
1295
  * Returns whether the player identity was confirmed by the Steam network.
1156
1296
  *
@@ -1160,30 +1300,35 @@ interface Player extends Entity {
1160
1300
  * @source https://wiki.facepunch.com/gmod/Player:IsFullyAuthenticated
1161
1301
  */
1162
1302
  IsFullyAuthenticated(self: Player): boolean;
1303
+
1163
1304
  /**
1164
1305
  * Returns if a player is the host of the current session.
1165
1306
  * @realm shared
1166
1307
  * @source https://wiki.facepunch.com/gmod/Player:IsListenServerHost
1167
1308
  */
1168
1309
  IsListenServerHost(self: Player): boolean;
1310
+
1169
1311
  /**
1170
1312
  * Returns whether or not the player is voice muted locally.
1171
1313
  * @realm client
1172
1314
  * @source https://wiki.facepunch.com/gmod/Player:IsMuted
1173
1315
  */
1174
1316
  IsMuted(self: Player): boolean;
1317
+
1175
1318
  /**
1176
1319
  * Returns true if the player is playing a taunt.
1177
1320
  * @realm shared
1178
1321
  * @source https://wiki.facepunch.com/gmod/Player:IsPlayingTaunt
1179
1322
  */
1180
1323
  IsPlayingTaunt(self: Player): boolean;
1324
+
1181
1325
  /**
1182
1326
  * Returns whenever the player is heard by the local player clientside, or if the player is speaking serverside.
1183
1327
  * @realm shared
1184
1328
  * @source https://wiki.facepunch.com/gmod/Player:IsSpeaking
1185
1329
  */
1186
1330
  IsSpeaking(self: Player): boolean;
1331
+
1187
1332
  /**
1188
1333
  * Returns whether the player is currently sprinting or not, specifically if they are holding their sprint key and are allowed to sprint.
1189
1334
  *
@@ -1192,6 +1337,7 @@ interface Player extends Entity {
1192
1337
  * @source https://wiki.facepunch.com/gmod/Player:IsSprinting
1193
1338
  */
1194
1339
  IsSprinting(self: Player): boolean;
1340
+
1195
1341
  /**
1196
1342
  * Returns whenever the player is equipped with the suit item.
1197
1343
  *
@@ -1201,6 +1347,7 @@ interface Player extends Entity {
1201
1347
  * @source https://wiki.facepunch.com/gmod/Player:IsSuitEquipped
1202
1348
  */
1203
1349
  IsSuitEquipped(self: Player): boolean;
1350
+
1204
1351
  /**
1205
1352
  * Returns whether the player is a super admin.
1206
1353
  *
@@ -1210,6 +1357,7 @@ interface Player extends Entity {
1210
1357
  * @source https://wiki.facepunch.com/gmod/Player:IsSuperAdmin
1211
1358
  */
1212
1359
  IsSuperAdmin(self: Player): boolean;
1360
+
1213
1361
  /**
1214
1362
  * Returns `true` if the player is timing out (i.e. is losing connection), `false` otherwise.
1215
1363
  *
@@ -1218,6 +1366,7 @@ interface Player extends Entity {
1218
1366
  * @source https://wiki.facepunch.com/gmod/Player:IsTimingOut
1219
1367
  */
1220
1368
  IsTimingOut(self: Player): boolean;
1369
+
1221
1370
  /**
1222
1371
  * Returns whether the player is typing in their chat.
1223
1372
  *
@@ -1227,24 +1376,28 @@ interface Player extends Entity {
1227
1376
  * @source https://wiki.facepunch.com/gmod/Player:IsTyping
1228
1377
  */
1229
1378
  IsTyping(self: Player): boolean;
1379
+
1230
1380
  /**
1231
1381
  * Returns whether the player is in specified group or not. See [Player:GetUserGroup](https://wiki.facepunch.com/gmod/Player:GetUserGroup) for a way to get player's user group.
1232
1382
  * @realm shared
1233
1383
  * @source https://wiki.facepunch.com/gmod/Player:IsUserGroup
1234
1384
  */
1235
1385
  IsUserGroup(self: Player, groupName: string): boolean;
1386
+
1236
1387
  /**
1237
1388
  * Returns if the player can be heard by the local player.
1238
1389
  * @realm client
1239
1390
  * @source https://wiki.facepunch.com/gmod/Player:IsVoiceAudible
1240
1391
  */
1241
1392
  IsVoiceAudible(self: Player): boolean;
1393
+
1242
1394
  /**
1243
1395
  * Returns if the player currently walking. (`+walk` keybind)
1244
1396
  * @realm shared
1245
1397
  * @source https://wiki.facepunch.com/gmod/Player:IsWalking
1246
1398
  */
1247
1399
  IsWalking(self: Player): boolean;
1400
+
1248
1401
  /**
1249
1402
  * Returns whether the player is using the world clicking feature, see [Panel:SetWorldClicker](https://wiki.facepunch.com/gmod/Panel:SetWorldClicker)
1250
1403
  *
@@ -1252,6 +1405,7 @@ interface Player extends Entity {
1252
1405
  * @source https://wiki.facepunch.com/gmod/Player:IsWorldClicking
1253
1406
  */
1254
1407
  IsWorldClicking(self: Player): boolean;
1408
+
1255
1409
  /**
1256
1410
  * Returns whether the world clicking is disabled for given player or not. See [Player:DisableWorldClicking](https://wiki.facepunch.com/gmod/Player:DisableWorldClicking).
1257
1411
  *
@@ -1259,30 +1413,35 @@ interface Player extends Entity {
1259
1413
  * @source https://wiki.facepunch.com/gmod/Player:IsWorldClickingDisabled
1260
1414
  */
1261
1415
  IsWorldClickingDisabled(self: Player): boolean;
1416
+
1262
1417
  /**
1263
1418
  * Returns whether a key is down. This is not networked to other players, meaning only the local client can see the keys they are pressing.
1264
1419
  * @realm shared
1265
1420
  * @source https://wiki.facepunch.com/gmod/Player:KeyDown
1266
1421
  */
1267
1422
  KeyDown(self: Player, key: number): boolean;
1423
+
1268
1424
  /**
1269
1425
  * Gets whether a key was down one tick ago.
1270
1426
  * @realm shared
1271
1427
  * @source https://wiki.facepunch.com/gmod/Player:KeyDownLast
1272
1428
  */
1273
1429
  KeyDownLast(self: Player, key: number): boolean;
1430
+
1274
1431
  /**
1275
1432
  * Gets whether a key was just pressed this tick.
1276
1433
  * @realm shared
1277
1434
  * @source https://wiki.facepunch.com/gmod/Player:KeyPressed
1278
1435
  */
1279
1436
  KeyPressed(self: Player, key: number): boolean;
1437
+
1280
1438
  /**
1281
1439
  * Gets whether a key was just released this tick.
1282
1440
  * @realm shared
1283
1441
  * @source https://wiki.facepunch.com/gmod/Player:KeyReleased
1284
1442
  */
1285
1443
  KeyReleased(self: Player, key: number): boolean;
1444
+
1286
1445
  /**
1287
1446
  * Kicks the player from the server.
1288
1447
  * **NOTE**: This can not be run before the player has fully joined in. Use [game.KickID](https://wiki.facepunch.com/gmod/game.KickID) for that.
@@ -1292,12 +1451,14 @@ interface Player extends Entity {
1292
1451
  * @source https://wiki.facepunch.com/gmod/Player:Kick
1293
1452
  */
1294
1453
  Kick(self: Player, reason?: string): void;
1454
+
1295
1455
  /**
1296
1456
  * Kills a player and calls [GM:PlayerDeath](https://wiki.facepunch.com/gmod/GM:PlayerDeath).
1297
1457
  * @realm server
1298
1458
  * @source https://wiki.facepunch.com/gmod/Player:Kill
1299
1459
  */
1300
1460
  Kill(self: Player): void;
1461
+
1301
1462
  /**
1302
1463
  * Kills a player without notifying the rest of the server.
1303
1464
  *
@@ -1307,6 +1468,7 @@ interface Player extends Entity {
1307
1468
  * @source https://wiki.facepunch.com/gmod/Player:KillSilent
1308
1469
  */
1309
1470
  KillSilent(self: Player): void;
1471
+
1310
1472
  /**
1311
1473
  * This allows the server to mitigate the lag of the player by moving back all the entities that can be lag compensated to the time the player attacked with his weapon.
1312
1474
  *
@@ -1328,12 +1490,14 @@ interface Player extends Entity {
1328
1490
  * @source https://wiki.facepunch.com/gmod/Player:LagCompensation
1329
1491
  */
1330
1492
  LagCompensation(self: Player, lagCompensation: boolean): void;
1493
+
1331
1494
  /**
1332
1495
  * Returns the hitgroup where the player was last hit.
1333
1496
  * @realm server
1334
1497
  * @source https://wiki.facepunch.com/gmod/Player:LastHitGroup
1335
1498
  */
1336
1499
  LastHitGroup(self: Player): number;
1500
+
1337
1501
  /**
1338
1502
  * Shows "limit hit" notification in sandbox.
1339
1503
  * **NOTE**: This function is only available in Sandbox and its derivatives.
@@ -1343,6 +1507,7 @@ interface Player extends Entity {
1343
1507
  * @source https://wiki.facepunch.com/gmod/Player:LimitHit
1344
1508
  */
1345
1509
  LimitHit(self: Player, type: string): void;
1510
+
1346
1511
  /**
1347
1512
  * Returns the direction a player is looking as a entity/local-oriented angle.
1348
1513
  *
@@ -1354,6 +1519,7 @@ interface Player extends Entity {
1354
1519
  * @source https://wiki.facepunch.com/gmod/Player:LocalEyeAngles
1355
1520
  */
1356
1521
  LocalEyeAngles(self: Player): Angle;
1522
+
1357
1523
  /**
1358
1524
  * Stops a player from using any inputs, such as moving, turning, or attacking. Key binds are still called. Similar to [Player:Freeze](https://wiki.facepunch.com/gmod/Player:Freeze) but the player takes no damage.
1359
1525
  *
@@ -1364,12 +1530,14 @@ interface Player extends Entity {
1364
1530
  * @source https://wiki.facepunch.com/gmod/Player:Lock
1365
1531
  */
1366
1532
  Lock(self: Player): void;
1533
+
1367
1534
  /**
1368
1535
  * Returns the position of a Kinect bone.
1369
1536
  * @realm shared
1370
1537
  * @source https://wiki.facepunch.com/gmod/Player:MotionSensorPos
1371
1538
  */
1372
1539
  MotionSensorPos(self: Player, bone: number): Vector;
1540
+
1373
1541
  /**
1374
1542
  * Returns the player's nick name. Identical to [Player:Nick](https://wiki.facepunch.com/gmod/Player:Nick) and [Player:GetName](https://wiki.facepunch.com/gmod/Player:GetName).
1375
1543
  * @realm shared
@@ -1377,12 +1545,14 @@ interface Player extends Entity {
1377
1545
  * @deprecated Use Player:Nick.
1378
1546
  */
1379
1547
  Name(self: Player): string;
1548
+
1380
1549
  /**
1381
1550
  * Returns the player's nick name also known as display name, as it appears in Steam.
1382
1551
  * @realm shared
1383
1552
  * @source https://wiki.facepunch.com/gmod/Player:Nick
1384
1553
  */
1385
1554
  Nick(self: Player): string;
1555
+
1386
1556
  /**
1387
1557
  * Returns the 64-bit SteamID aka CommunityID of the Steam Account that owns the Garry's Mod license this player is using. This is useful for detecting players using Steam Family Sharing.
1388
1558
  *
@@ -1395,12 +1565,14 @@ interface Player extends Entity {
1395
1565
  * @source https://wiki.facepunch.com/gmod/Player:OwnerSteamID64
1396
1566
  */
1397
1567
  OwnerSteamID64(self: Player): string;
1568
+
1398
1569
  /**
1399
1570
  * Returns the percentage of packets lost by the client. It is not networked so it only returns 0 when run clientside.
1400
1571
  * @realm shared
1401
1572
  * @source https://wiki.facepunch.com/gmod/Player:PacketLoss
1402
1573
  */
1403
1574
  PacketLoss(self: Player): number;
1575
+
1404
1576
  /**
1405
1577
  * Unfreezes the props player is looking at. This is essentially the same as pressing reload with the physics gun, including double press for unfreeze all.
1406
1578
  *
@@ -1409,6 +1581,7 @@ interface Player extends Entity {
1409
1581
  * @source https://wiki.facepunch.com/gmod/Player:PhysgunUnfreeze
1410
1582
  */
1411
1583
  PhysgunUnfreeze(self: Player): number;
1584
+
1412
1585
  /**
1413
1586
  * This makes the player hold (same as pressing E on a small prop) given entity.
1414
1587
  *
@@ -1420,6 +1593,7 @@ interface Player extends Entity {
1420
1593
  * @source https://wiki.facepunch.com/gmod/Player:PickupObject
1421
1594
  */
1422
1595
  PickupObject(self: Player, entity: Entity): void;
1596
+
1423
1597
  /**
1424
1598
  * Forces the player to pickup an existing weapon entity. The player will not pick up the weapon if they already own a weapon of given type, or if the player could not normally have this weapon in their inventory.
1425
1599
  *
@@ -1429,18 +1603,21 @@ interface Player extends Entity {
1429
1603
  * @source https://wiki.facepunch.com/gmod/Player:PickupWeapon
1430
1604
  */
1431
1605
  PickupWeapon(self: Player, wep: Weapon, ammoOnly?: boolean): boolean;
1606
+
1432
1607
  /**
1433
1608
  * Returns the player's ping to server.
1434
1609
  * @realm shared
1435
1610
  * @source https://wiki.facepunch.com/gmod/Player:Ping
1436
1611
  */
1437
1612
  Ping(self: Player): number;
1613
+
1438
1614
  /**
1439
1615
  * Plays the correct step sound according to what the player is staying on.
1440
1616
  * @realm server
1441
1617
  * @source https://wiki.facepunch.com/gmod/Player:PlayStepSound
1442
1618
  */
1443
1619
  PlayStepSound(self: Player, volume?: number): void;
1620
+
1444
1621
  /**
1445
1622
  * Displays a message either in their chat, console, or center of the screen. See also [Global.PrintMessage](https://wiki.facepunch.com/gmod/Global.PrintMessage).
1446
1623
  *
@@ -1453,24 +1630,28 @@ interface Player extends Entity {
1453
1630
  * @source https://wiki.facepunch.com/gmod/Player:PrintMessage
1454
1631
  */
1455
1632
  PrintMessage(self: Player, type: number, message: string): void;
1633
+
1456
1634
  /**
1457
1635
  * Removes all ammo from a certain player
1458
1636
  * @realm server
1459
1637
  * @source https://wiki.facepunch.com/gmod/Player:RemoveAllAmmo
1460
1638
  */
1461
1639
  RemoveAllAmmo(self: Player): void;
1640
+
1462
1641
  /**
1463
1642
  * Removes all weapons and ammo from the player.
1464
1643
  * @realm server
1465
1644
  * @source https://wiki.facepunch.com/gmod/Player:RemoveAllItems
1466
1645
  */
1467
1646
  RemoveAllItems(self: Player): void;
1647
+
1468
1648
  /**
1469
1649
  * Removes the amount of the specified ammo from the player.
1470
1650
  * @realm shared
1471
1651
  * @source https://wiki.facepunch.com/gmod/Player:RemoveAmmo
1472
1652
  */
1473
1653
  RemoveAmmo(self: Player, ammoCount: number, ammoName: string | number): void;
1654
+
1474
1655
  /**
1475
1656
  * Removes a **P**ersistent **Data** key-value pair from the SQL database. (`sv.db` when called on server, `cl.db` when called on client)
1476
1657
  *
@@ -1485,18 +1666,21 @@ interface Player extends Entity {
1485
1666
  * @source https://wiki.facepunch.com/gmod/Player:RemovePData
1486
1667
  */
1487
1668
  RemovePData(self: Player, key: string): boolean;
1669
+
1488
1670
  /**
1489
1671
  * Strips the player's suit item.
1490
1672
  * @realm server
1491
1673
  * @source https://wiki.facepunch.com/gmod/Player:RemoveSuit
1492
1674
  */
1493
1675
  RemoveSuit(self: Player): void;
1676
+
1494
1677
  /**
1495
1678
  * Resets both normal and duck hulls to their default values.
1496
1679
  * @realm shared
1497
1680
  * @source https://wiki.facepunch.com/gmod/Player:ResetHull
1498
1681
  */
1499
1682
  ResetHull(self: Player): void;
1683
+
1500
1684
  /**
1501
1685
  * Forces the player to say whatever the first argument is. Works on bots too.
1502
1686
  *
@@ -1509,12 +1693,14 @@ interface Player extends Entity {
1509
1693
  * @source https://wiki.facepunch.com/gmod/Player:Say
1510
1694
  */
1511
1695
  Say(self: Player, text: string, teamOnly?: boolean): void;
1696
+
1512
1697
  /**
1513
1698
  * Fades the screen
1514
1699
  * @realm shared
1515
1700
  * @source https://wiki.facepunch.com/gmod/Player:ScreenFade
1516
1701
  */
1517
1702
  ScreenFade(self: Player, flags: number, color?: Color, fadeTime?: number, fadeHold?: number): void;
1703
+
1518
1704
  /**
1519
1705
  * Sets the active weapon of the player by its class name.
1520
1706
  *
@@ -1528,6 +1714,7 @@ interface Player extends Entity {
1528
1714
  * @source https://wiki.facepunch.com/gmod/Player:SelectWeapon
1529
1715
  */
1530
1716
  SelectWeapon(self: Player, className: string): void;
1717
+
1531
1718
  /**
1532
1719
  * Sends a hint to a player.
1533
1720
  *
@@ -1538,6 +1725,7 @@ interface Player extends Entity {
1538
1725
  * @source https://wiki.facepunch.com/gmod/Player:SendHint
1539
1726
  */
1540
1727
  SendHint(self: Player, name: string, delay: number): void;
1728
+
1541
1729
  /**
1542
1730
  * Executes a simple Lua string on the player.
1543
1731
  * **NOTE**: If you need to use this function more than once consider using [net](https://wiki.facepunch.com/gmod/net) library. Send net message and make the entire code you want to execute in [net.Receive](https://wiki.facepunch.com/gmod/net.Receive) on client.
@@ -1547,6 +1735,7 @@ interface Player extends Entity {
1547
1735
  * @source https://wiki.facepunch.com/gmod/Player:SendLua
1548
1736
  */
1549
1737
  SendLua(self: Player, script: string): void;
1738
+
1550
1739
  /**
1551
1740
  * Sets the player's active weapon. You should use [CUserCmd:SelectWeapon](https://wiki.facepunch.com/gmod/CUserCmd:SelectWeapon) or [Player:SelectWeapon](https://wiki.facepunch.com/gmod/Player:SelectWeapon), instead in most cases.
1552
1741
  *
@@ -1557,18 +1746,21 @@ interface Player extends Entity {
1557
1746
  * @source https://wiki.facepunch.com/gmod/Player:SetActiveWeapon
1558
1747
  */
1559
1748
  SetActiveWeapon(self: Player, weapon: Weapon): void;
1749
+
1560
1750
  /**
1561
1751
  * Sets the player's activity.
1562
1752
  * @realm server
1563
1753
  * @source https://wiki.facepunch.com/gmod/Player:SetActivity
1564
1754
  */
1565
1755
  SetActivity(self: Player, act: number): void;
1756
+
1566
1757
  /**
1567
1758
  * Set if the players' model is allowed to rotate around the pitch and roll axis.
1568
1759
  * @realm shared
1569
1760
  * @source https://wiki.facepunch.com/gmod/Player:SetAllowFullRotation
1570
1761
  */
1571
1762
  SetAllowFullRotation(self: Player, Allowed: boolean): void;
1763
+
1572
1764
  /**
1573
1765
  * Allows player to use their weapons in a vehicle. You need to call this before entering a vehicle.
1574
1766
  *
@@ -1578,12 +1770,14 @@ interface Player extends Entity {
1578
1770
  * @source https://wiki.facepunch.com/gmod/Player:SetAllowWeaponsInVehicle
1579
1771
  */
1580
1772
  SetAllowWeaponsInVehicle(self: Player, allow: boolean): void;
1773
+
1581
1774
  /**
1582
1775
  * Sets the amount of the specified ammo for the player.
1583
1776
  * @realm shared
1584
1777
  * @source https://wiki.facepunch.com/gmod/Player:SetAmmo
1585
1778
  */
1586
1779
  SetAmmo(self: Player, ammoCount: number, ammoType: any): void;
1780
+
1587
1781
  /**
1588
1782
  * Sets the player armor value.
1589
1783
  *
@@ -1593,6 +1787,7 @@ interface Player extends Entity {
1593
1787
  * @source https://wiki.facepunch.com/gmod/Player:SetArmor
1594
1788
  */
1595
1789
  SetArmor(self: Player, amount: number): void;
1790
+
1596
1791
  /**
1597
1792
  * Pushes the player away from other players whenever the player inside another players' bounding box.
1598
1793
  *
@@ -1603,18 +1798,21 @@ interface Player extends Entity {
1603
1798
  * @source https://wiki.facepunch.com/gmod/Player:SetAvoidPlayers
1604
1799
  */
1605
1800
  SetAvoidPlayers(self: Player, avoidPlayers: boolean): void;
1801
+
1606
1802
  /**
1607
1803
  * Set if the player should be allowed to walk using the (default) alt key. (`+walk` keybind)
1608
1804
  * @realm shared
1609
1805
  * @source https://wiki.facepunch.com/gmod/Player:SetCanWalk
1610
1806
  */
1611
1807
  SetCanWalk(self: Player, canWalk: boolean): void;
1808
+
1612
1809
  /**
1613
1810
  * Sets whether the player can use the HL2 suit zoom (`+zoom` bind) or not.
1614
1811
  * @realm shared
1615
1812
  * @source https://wiki.facepunch.com/gmod/Player:SetCanZoom
1616
1813
  */
1617
1814
  SetCanZoom(self: Player, canZoom: boolean): void;
1815
+
1618
1816
  /**
1619
1817
  * **INTERNAL**: Use [player_manager.SetPlayerClass](https://wiki.facepunch.com/gmod/player_manager.SetPlayerClass) instead.
1620
1818
  *
@@ -1624,6 +1822,7 @@ interface Player extends Entity {
1624
1822
  * @source https://wiki.facepunch.com/gmod/Player:SetClassID
1625
1823
  */
1626
1824
  SetClassID(self: Player, classID: number): void;
1825
+
1627
1826
  /**
1628
1827
  * Sets the crouched walk speed multiplier.
1629
1828
  *
@@ -1635,6 +1834,7 @@ interface Player extends Entity {
1635
1834
  * @source https://wiki.facepunch.com/gmod/Player:SetCrouchedWalkSpeed
1636
1835
  */
1637
1836
  SetCrouchedWalkSpeed(self: Player, speed: number): void;
1837
+
1638
1838
  /**
1639
1839
  * Sets the **actual** view offset which equals the difference between the players actual position and their view when standing.
1640
1840
  *
@@ -1644,6 +1844,7 @@ interface Player extends Entity {
1644
1844
  * @source https://wiki.facepunch.com/gmod/Player:SetCurrentViewOffset
1645
1845
  */
1646
1846
  SetCurrentViewOffset(self: Player, viewOffset: Vector): void;
1847
+
1647
1848
  /**
1648
1849
  * Activates a given DSP (Digital Signal Processor) effect on all sounds that
1649
1850
  * the player hears. Equivalent to setting the `dsp_player` convar on the player.
@@ -1651,12 +1852,14 @@ interface Player extends Entity {
1651
1852
  * @source https://wiki.facepunch.com/gmod/Player:SetDSP
1652
1853
  */
1653
1854
  SetDSP(self: Player, dspEffectId: number, fastReset?: boolean): void;
1855
+
1654
1856
  /**
1655
1857
  * Sets a player's death count
1656
1858
  * @realm server
1657
1859
  * @source https://wiki.facepunch.com/gmod/Player:SetDeaths
1658
1860
  */
1659
1861
  SetDeaths(self: Player, deathCount: number): void;
1862
+
1660
1863
  /**
1661
1864
  * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
1662
1865
  *
@@ -1668,6 +1871,7 @@ interface Player extends Entity {
1668
1871
  * @source https://wiki.facepunch.com/gmod/Player:SetDrivingEntity
1669
1872
  */
1670
1873
  SetDrivingEntity(self: Player, drivingEntity?: Entity, drivingMode?: number): void;
1874
+
1671
1875
  /**
1672
1876
  * Sets how quickly a player ducks.
1673
1877
  *
@@ -1677,6 +1881,7 @@ interface Player extends Entity {
1677
1881
  * @source https://wiki.facepunch.com/gmod/Player:SetDuckSpeed
1678
1882
  */
1679
1883
  SetDuckSpeed(self: Player, duckSpeed: number): void;
1884
+
1680
1885
  /**
1681
1886
  * Sets the local angle of the player's view (may rotate body too if angular difference is large)
1682
1887
  *
@@ -1687,6 +1892,7 @@ interface Player extends Entity {
1687
1892
  * @source https://wiki.facepunch.com/gmod/Player:SetEyeAngles
1688
1893
  */
1689
1894
  SetEyeAngles(self: Player, angle: Angle): void;
1895
+
1690
1896
  /**
1691
1897
  * Set a player's FOV (Field Of View) over a certain amount of time.
1692
1898
  *
@@ -1695,6 +1901,7 @@ interface Player extends Entity {
1695
1901
  * @source https://wiki.facepunch.com/gmod/Player:SetFOV
1696
1902
  */
1697
1903
  SetFOV(self: Player, fov: number, time?: number, requester?: Entity): void;
1904
+
1698
1905
  /**
1699
1906
  * Sets the color of a player's flashlight.
1700
1907
  * Can be used on other players.
@@ -1703,12 +1910,14 @@ interface Player extends Entity {
1703
1910
  * @source https://wiki.facepunch.com/gmod/Player:SetFlashlightColor
1704
1911
  */
1705
1912
  SetFlashlightColor(self: Player, color?: Color): void;
1913
+
1706
1914
  /**
1707
1915
  * Sets a player's frags (kills)
1708
1916
  * @realm server
1709
1917
  * @source https://wiki.facepunch.com/gmod/Player:SetFrags
1710
1918
  */
1711
1919
  SetFrags(self: Player, fragCount: number): void;
1920
+
1712
1921
  /**
1713
1922
  * Sets the hands entity of a player.
1714
1923
  *
@@ -1719,12 +1928,14 @@ interface Player extends Entity {
1719
1928
  * @source https://wiki.facepunch.com/gmod/Player:SetHands
1720
1929
  */
1721
1930
  SetHands(self: Player, hands: Entity): void;
1931
+
1722
1932
  /**
1723
1933
  * Sets the widget that is currently hovered by the player's mouse.
1724
1934
  * @realm shared
1725
1935
  * @source https://wiki.facepunch.com/gmod/Player:SetHoveredWidget
1726
1936
  */
1727
1937
  SetHoveredWidget(self: Player, widget?: Entity): void;
1938
+
1728
1939
  /**
1729
1940
  * Sets the size of the [Player's](https://wiki.facepunch.com/gmod/Player) [Axis-Aligned Bounding Box (AABB)](https://en.wikipedia.org/wiki/Minimum_bounding_box) used for physics and movement [Hull Traces](https://wiki.facepunch.com/gmod/util.TraceHull).
1730
1941
  *
@@ -1737,6 +1948,7 @@ interface Player extends Entity {
1737
1948
  * @source https://wiki.facepunch.com/gmod/Player:SetHull
1738
1949
  */
1739
1950
  SetHull(self: Player, mins: Vector, maxs: Vector): void;
1951
+
1740
1952
  /**
1741
1953
  * Sets the size of the [Player's](https://wiki.facepunch.com/gmod/Player) [Axis-Aligned Bounding Box (AABB)](https://en.wikipedia.org/wiki/Minimum_bounding_box) used for physics and movement [Hull Traces](https://wiki.facepunch.com/gmod/util.TraceHull) while they are crouching (or "Ducking").
1742
1954
  *
@@ -1749,12 +1961,14 @@ interface Player extends Entity {
1749
1961
  * @source https://wiki.facepunch.com/gmod/Player:SetHullDuck
1750
1962
  */
1751
1963
  SetHullDuck(self: Player, mins: Vector, maxs: Vector): void;
1964
+
1752
1965
  /**
1753
1966
  * Sets the jump power, eg. the velocity that will be applied to the player when they jump.
1754
1967
  * @realm shared
1755
1968
  * @source https://wiki.facepunch.com/gmod/Player:SetJumpPower
1756
1969
  */
1757
1970
  SetJumpPower(self: Player, jumpPower: number): void;
1971
+
1758
1972
  /**
1759
1973
  * Sets the player's ladder climbing speed.
1760
1974
  *
@@ -1764,6 +1978,7 @@ interface Player extends Entity {
1764
1978
  * @source https://wiki.facepunch.com/gmod/Player:SetLadderClimbSpeed
1765
1979
  */
1766
1980
  SetLadderClimbSpeed(self: Player, speed: number): void;
1981
+
1767
1982
  /**
1768
1983
  * Slows down the player movement simulation by the timescale, this is used internally in the HL2 weapon stripping sequence.
1769
1984
  *
@@ -1778,12 +1993,14 @@ interface Player extends Entity {
1778
1993
  * @source https://wiki.facepunch.com/gmod/Player:SetLaggedMovementValue
1779
1994
  */
1780
1995
  SetLaggedMovementValue(self: Player, timescale: number): void;
1996
+
1781
1997
  /**
1782
1998
  * Sets the hitgroup where the player was last hit.
1783
1999
  * @realm server
1784
2000
  * @source https://wiki.facepunch.com/gmod/Player:SetLastHitGroup
1785
2001
  */
1786
2002
  SetLastHitGroup(self: Player, hitgroup: number): void;
2003
+
1787
2004
  /**
1788
2005
  * Sets the maximum amount of armor the player should have. This affects default built-in armor pickups, but not [Player:SetArmor](https://wiki.facepunch.com/gmod/Player:SetArmor).
1789
2006
  *
@@ -1791,6 +2008,7 @@ interface Player extends Entity {
1791
2008
  * @source https://wiki.facepunch.com/gmod/Player:SetMaxArmor
1792
2009
  */
1793
2010
  SetMaxArmor(self: Player, maxarmor: number): void;
2011
+
1794
2012
  /**
1795
2013
  * Sets the maximum speed which the player can move at.
1796
2014
  *
@@ -1801,12 +2019,14 @@ interface Player extends Entity {
1801
2019
  * @source https://wiki.facepunch.com/gmod/Player:SetMaxSpeed
1802
2020
  */
1803
2021
  SetMaxSpeed(self: Player, walkSpeed: number): void;
2022
+
1804
2023
  /**
1805
2024
  * Sets if the player should be voicechat muted locally.
1806
2025
  * @realm client
1807
2026
  * @source https://wiki.facepunch.com/gmod/Player:SetMuted
1808
2027
  */
1809
2028
  SetMuted(self: Player, mute: boolean): void;
2029
+
1810
2030
  /**
1811
2031
  * Sets whenever the player should not collide with their teammates, based on their [Player:Team](https://wiki.facepunch.com/gmod/Player:Team).
1812
2032
  *
@@ -1819,6 +2039,7 @@ interface Player extends Entity {
1819
2039
  * @source https://wiki.facepunch.com/gmod/Player:SetNoCollideWithTeammates
1820
2040
  */
1821
2041
  SetNoCollideWithTeammates(self: Player, shouldNotCollide: boolean): void;
2042
+
1822
2043
  /**
1823
2044
  * Sets the players visibility towards NPCs.
1824
2045
  *
@@ -1828,12 +2049,14 @@ interface Player extends Entity {
1828
2049
  * @source https://wiki.facepunch.com/gmod/Player:SetNoTarget
1829
2050
  */
1830
2051
  SetNoTarget(self: Player, visibility: boolean): void;
2052
+
1831
2053
  /**
1832
2054
  * Sets the players observer mode. You must start the spectating first with [Player:Spectate](https://wiki.facepunch.com/gmod/Player:Spectate).
1833
2055
  * @realm shared
1834
2056
  * @source https://wiki.facepunch.com/gmod/Player:SetObserverMode
1835
2057
  */
1836
2058
  SetObserverMode(self: Player, mode: number): void;
2059
+
1837
2060
  /**
1838
2061
  * Writes a **P**ersistent **Data** key-value pair to the SQL database. (`sv.db` when called on server, `cl.db` when called on client)
1839
2062
  *
@@ -1849,12 +2072,14 @@ interface Player extends Entity {
1849
2072
  * @source https://wiki.facepunch.com/gmod/Player:SetPData
1850
2073
  */
1851
2074
  SetPData(self: Player, key: string, value: any): boolean;
2075
+
1852
2076
  /**
1853
2077
  * Sets the player model's color. The part of the model that is colored is determined by the model itself, and is different for each model.
1854
2078
  * @realm shared
1855
2079
  * @source https://wiki.facepunch.com/gmod/Player:SetPlayerColor
1856
2080
  */
1857
2081
  SetPlayerColor(self: Player, Color: Vector): void;
2082
+
1858
2083
  /**
1859
2084
  * Sets the widget that is currently in use by the player's mouse.
1860
2085
  *
@@ -1864,6 +2089,7 @@ interface Player extends Entity {
1864
2089
  * @source https://wiki.facepunch.com/gmod/Player:SetPressedWidget
1865
2090
  */
1866
2091
  SetPressedWidget(self: Player, pressedWidget?: Entity): void;
2092
+
1867
2093
  /**
1868
2094
  * Sets the player's sprint speed.
1869
2095
  *
@@ -1875,6 +2101,7 @@ interface Player extends Entity {
1875
2101
  * @source https://wiki.facepunch.com/gmod/Player:SetRunSpeed
1876
2102
  */
1877
2103
  SetRunSpeed(self: Player, runSpeed: number): void;
2104
+
1878
2105
  /**
1879
2106
  * Sets the player's slow walking speed, which is activated via +WALK keybind.
1880
2107
  *
@@ -1884,12 +2111,14 @@ interface Player extends Entity {
1884
2111
  * @source https://wiki.facepunch.com/gmod/Player:SetSlowWalkSpeed
1885
2112
  */
1886
2113
  SetSlowWalkSpeed(self: Player, speed: number): void;
2114
+
1887
2115
  /**
1888
2116
  * Sets the maximum height a player can step onto without jumping.
1889
2117
  * @realm shared
1890
2118
  * @source https://wiki.facepunch.com/gmod/Player:SetStepSize
1891
2119
  */
1892
2120
  SetStepSize(self: Player, stepHeight: number): void;
2121
+
1893
2122
  /**
1894
2123
  * Sets the player's HEV suit power.
1895
2124
  *
@@ -1899,12 +2128,14 @@ interface Player extends Entity {
1899
2128
  * @source https://wiki.facepunch.com/gmod/Player:SetSuitPower
1900
2129
  */
1901
2130
  SetSuitPower(self: Player, power: number): void;
2131
+
1902
2132
  /**
1903
2133
  * Sets whenever to suppress the pickup notification for the player.
1904
2134
  * @realm shared
1905
2135
  * @source https://wiki.facepunch.com/gmod/Player:SetSuppressPickupNotices
1906
2136
  */
1907
2137
  SetSuppressPickupNotices(self: Player, doSuppress: boolean): void;
2138
+
1908
2139
  /**
1909
2140
  * Sets the player to the chosen team. The value is networked to clients at reduced bit count (16 bits) as as a signed value, so the real range is [-32768, 32767].
1910
2141
  *
@@ -1914,24 +2145,28 @@ interface Player extends Entity {
1914
2145
  * @source https://wiki.facepunch.com/gmod/Player:SetTeam
1915
2146
  */
1916
2147
  SetTeam(self: Player, team: number): void;
2148
+
1917
2149
  /**
1918
2150
  * Sets how quickly a player un-ducks
1919
2151
  * @realm shared
1920
2152
  * @source https://wiki.facepunch.com/gmod/Player:SetUnDuckSpeed
1921
2153
  */
1922
2154
  SetUnDuckSpeed(self: Player, UnDuckSpeed: number): void;
2155
+
1923
2156
  /**
1924
2157
  * Sets the usergroup of the player.
1925
2158
  * @realm server
1926
2159
  * @source https://wiki.facepunch.com/gmod/Player:SetUserGroup
1927
2160
  */
1928
2161
  SetUserGroup(self: Player, groupName: string): void;
2162
+
1929
2163
  /**
1930
2164
  * Attaches the players view to the position and angles of the specified entity.
1931
2165
  * @realm server
1932
2166
  * @source https://wiki.facepunch.com/gmod/Player:SetViewEntity
1933
2167
  */
1934
2168
  SetViewEntity(self: Player, viewEntity: Entity): void;
2169
+
1935
2170
  /**
1936
2171
  * Sets the **desired** view offset which equals the difference between the players actual position and their view when standing.
1937
2172
  *
@@ -1943,6 +2178,7 @@ interface Player extends Entity {
1943
2178
  * @source https://wiki.facepunch.com/gmod/Player:SetViewOffset
1944
2179
  */
1945
2180
  SetViewOffset(self: Player, viewOffset: Vector): void;
2181
+
1946
2182
  /**
1947
2183
  * Sets the **desired** view offset which equals the difference between the players actual position and their view when crouching.
1948
2184
  *
@@ -1954,18 +2190,21 @@ interface Player extends Entity {
1954
2190
  * @source https://wiki.facepunch.com/gmod/Player:SetViewOffsetDucked
1955
2191
  */
1956
2192
  SetViewOffsetDucked(self: Player, viewOffset: Vector): void;
2193
+
1957
2194
  /**
1958
2195
  * Sets client's view punch angle, but not the velocity. See [Player:ViewPunch](https://wiki.facepunch.com/gmod/Player:ViewPunch)
1959
2196
  * @realm shared
1960
2197
  * @source https://wiki.facepunch.com/gmod/Player:SetViewPunchAngles
1961
2198
  */
1962
2199
  SetViewPunchAngles(self: Player, punchAngle: Angle): void;
2200
+
1963
2201
  /**
1964
2202
  * Sets client's view punch velocity. See [Player:ViewPunch](https://wiki.facepunch.com/gmod/Player:ViewPunch) and [Player:SetViewPunchAngles](https://wiki.facepunch.com/gmod/Player:SetViewPunchAngles)
1965
2203
  * @realm shared
1966
2204
  * @source https://wiki.facepunch.com/gmod/Player:SetViewPunchVelocity
1967
2205
  */
1968
2206
  SetViewPunchVelocity(self: Player, punchVel: Angle): void;
2207
+
1969
2208
  /**
1970
2209
  * Sets the voice volume scale for given player on client. This value will persist from server to server, but will be reset when the game is shut down.
1971
2210
  *
@@ -1976,6 +2215,7 @@ interface Player extends Entity {
1976
2215
  * @source https://wiki.facepunch.com/gmod/Player:SetVoiceVolumeScale
1977
2216
  */
1978
2217
  SetVoiceVolumeScale(self: Player, arg0: number): void;
2218
+
1979
2219
  /**
1980
2220
  * Sets the player's normal walking speed. Not sprinting, not slow walking +walk.
1981
2221
  *
@@ -1990,18 +2230,21 @@ interface Player extends Entity {
1990
2230
  * @source https://wiki.facepunch.com/gmod/Player:SetWalkSpeed
1991
2231
  */
1992
2232
  SetWalkSpeed(self: Player, walkSpeed: number): void;
2233
+
1993
2234
  /**
1994
2235
  * Sets the player weapon's color. The part of the model that is colored is determined by the model itself, and is different for each model.
1995
2236
  * @realm shared
1996
2237
  * @source https://wiki.facepunch.com/gmod/Player:SetWeaponColor
1997
2238
  */
1998
2239
  SetWeaponColor(self: Player, Color: Vector): void;
2240
+
1999
2241
  /**
2000
2242
  * Sets up the player's hands for the viewmodel. Calls [GM:PlayerSetHandsModel](https://wiki.facepunch.com/gmod/GM:PlayerSetHandsModel) to determine the model. If no entity is provided, uses the player's own hands model. If spectating another entity, pass that entity to use its hands model instead.
2001
2243
  * @realm server
2002
2244
  * @source https://wiki.facepunch.com/gmod/Player:SetupHands
2003
2245
  */
2004
2246
  SetupHands(self: Player, ent?: Entity): void;
2247
+
2005
2248
  /**
2006
2249
  * Returns whether the **local player's** player model will be drawn at the time the function is called.
2007
2250
  *
@@ -2011,6 +2254,7 @@ interface Player extends Entity {
2011
2254
  * @source https://wiki.facepunch.com/gmod/Player:ShouldDrawLocalPlayer
2012
2255
  */
2013
2256
  ShouldDrawLocalPlayer(self: Player): boolean;
2257
+
2014
2258
  /**
2015
2259
  * Sets whether the player's current weapon should drop on death.
2016
2260
  *
@@ -2021,24 +2265,28 @@ interface Player extends Entity {
2021
2265
  * @source https://wiki.facepunch.com/gmod/Player:ShouldDropWeapon
2022
2266
  */
2023
2267
  ShouldDropWeapon(self: Player, drop: boolean): void;
2268
+
2024
2269
  /**
2025
2270
  * Opens the player steam profile page in the steam overlay browser.
2026
2271
  * @realm client
2027
2272
  * @source https://wiki.facepunch.com/gmod/Player:ShowProfile
2028
2273
  */
2029
2274
  ShowProfile(self: Player): void;
2275
+
2030
2276
  /**
2031
2277
  * Signals the entity that it was dropped by the gravity gun.
2032
2278
  * @realm server
2033
2279
  * @source https://wiki.facepunch.com/gmod/Player:SimulateGravGunDrop
2034
2280
  */
2035
2281
  SimulateGravGunDrop(self: Player, ent: Entity): void;
2282
+
2036
2283
  /**
2037
2284
  * Signals the entity that it was picked up by the gravity gun. This call is only required if you want to simulate the situation of picking up objects.
2038
2285
  * @realm server
2039
2286
  * @source https://wiki.facepunch.com/gmod/Player:SimulateGravGunPickup
2040
2287
  */
2041
2288
  SimulateGravGunPickup(self: Player, ent: Entity, lightning?: boolean): void;
2289
+
2042
2290
  /**
2043
2291
  * Starts spectate mode for given player. This will also affect the players movetype in some cases.
2044
2292
  *
@@ -2050,6 +2298,7 @@ interface Player extends Entity {
2050
2298
  * @source https://wiki.facepunch.com/gmod/Player:Spectate
2051
2299
  */
2052
2300
  Spectate(self: Player, mode: OBS_MODE): void;
2301
+
2053
2302
  /**
2054
2303
  * Makes the player spectate the entity.
2055
2304
  *
@@ -2059,12 +2308,14 @@ interface Player extends Entity {
2059
2308
  * @source https://wiki.facepunch.com/gmod/Player:SpectateEntity
2060
2309
  */
2061
2310
  SpectateEntity(self: Player, entity: Entity): void;
2311
+
2062
2312
  /**
2063
2313
  * Makes a player spray their decal.
2064
2314
  * @realm server
2065
2315
  * @source https://wiki.facepunch.com/gmod/Player:SprayDecal
2066
2316
  */
2067
2317
  SprayDecal(self: Player, sprayOrigin: Vector, sprayEndPos: Vector): void;
2318
+
2068
2319
  /**
2069
2320
  * Disables the sprint on the player.
2070
2321
  *
@@ -2072,6 +2323,7 @@ interface Player extends Entity {
2072
2323
  * @source https://wiki.facepunch.com/gmod/Player:SprintDisable
2073
2324
  */
2074
2325
  SprintDisable(self: Player): void;
2326
+
2075
2327
  /**
2076
2328
  * Enables the sprint on the player.
2077
2329
  *
@@ -2079,6 +2331,7 @@ interface Player extends Entity {
2079
2331
  * @source https://wiki.facepunch.com/gmod/Player:SprintEnable
2080
2332
  */
2081
2333
  SprintEnable(self: Player): void;
2334
+
2082
2335
  /**
2083
2336
  * Doesn't appear to do anything.
2084
2337
  *
@@ -2087,6 +2340,7 @@ interface Player extends Entity {
2087
2340
  * @deprecated This appears to be a direct binding to internal functionality that is overridden by the engine every frame so calling these functions may not have any or expected effect.
2088
2341
  */
2089
2342
  StartSprinting(self: Player): void;
2343
+
2090
2344
  /**
2091
2345
  * When used in a [GM:SetupMove](https://wiki.facepunch.com/gmod/GM:SetupMove) hook, this function will force the player to walk, as well as preventing the player from sprinting.
2092
2346
  *
@@ -2095,6 +2349,7 @@ interface Player extends Entity {
2095
2349
  * @deprecated This appears to be a direct binding to internal functionality that is overridden by the engine every frame so calling these functions may not have any or expected effect.
2096
2350
  */
2097
2351
  StartWalking(self: Player): void;
2352
+
2098
2353
  /**
2099
2354
  * Returns the player's SteamID.
2100
2355
  *
@@ -2111,6 +2366,7 @@ interface Player extends Entity {
2111
2366
  * @source https://wiki.facepunch.com/gmod/Player:SteamID
2112
2367
  */
2113
2368
  SteamID(self: Player): string;
2369
+
2114
2370
  /**
2115
2371
  * Returns the player's full **64-bit SteamID**, also known as **CommunityID**. Information on how data is packed into this value can be found [here](https://developer.valvesoftware.com/wiki/SteamID).
2116
2372
  *
@@ -2127,6 +2383,7 @@ interface Player extends Entity {
2127
2383
  * @source https://wiki.facepunch.com/gmod/Player:SteamID64
2128
2384
  */
2129
2385
  SteamID64(self: Player): string;
2386
+
2130
2387
  /**
2131
2388
  * When used in a [GM:SetupMove](https://wiki.facepunch.com/gmod/GM:SetupMove) hook, this function will prevent the player from sprinting.
2132
2389
  *
@@ -2137,6 +2394,7 @@ interface Player extends Entity {
2137
2394
  * @deprecated This appears to be a direct binding to internal functionality that is overridden by the engine every frame so calling these functions may not have any or expected effect.
2138
2395
  */
2139
2396
  StopSprinting(self: Player): void;
2397
+
2140
2398
  /**
2141
2399
  * When used in a [GM:SetupMove](https://wiki.facepunch.com/gmod/GM:SetupMove) hook, this function behaves unexpectedly by preventing the player from sprinting similar to [Player:StopSprinting](https://wiki.facepunch.com/gmod/Player:StopSprinting).
2142
2400
  *
@@ -2145,6 +2403,7 @@ interface Player extends Entity {
2145
2403
  * @deprecated This appears to be a direct binding to internal functionality that is overridden by the engine every frame so calling these functions may not have any or expected effect.
2146
2404
  */
2147
2405
  StopWalking(self: Player): void;
2406
+
2148
2407
  /**
2149
2408
  * Turns off the zoom mode of the player. (+zoom console command)
2150
2409
  *
@@ -2154,6 +2413,7 @@ interface Player extends Entity {
2154
2413
  * @source https://wiki.facepunch.com/gmod/Player:StopZooming
2155
2414
  */
2156
2415
  StopZooming(self: Player): void;
2416
+
2157
2417
  /**
2158
2418
  * Removes all ammo from the player.
2159
2419
  * @realm server
@@ -2161,6 +2421,7 @@ interface Player extends Entity {
2161
2421
  * @deprecated Alias of Player:RemoveAllAmmo
2162
2422
  */
2163
2423
  StripAmmo(self: Player): void;
2424
+
2164
2425
  /**
2165
2426
  * Removes the specified weapon class from a certain player
2166
2427
  * **NOTE**: this function will call the [Entity:OnRemove](https://wiki.facepunch.com/gmod/Entity:OnRemove) but if you try use [Entity:GetOwner](https://wiki.facepunch.com/gmod/Entity:GetOwner) it will return nil
@@ -2169,12 +2430,14 @@ interface Player extends Entity {
2169
2430
  * @source https://wiki.facepunch.com/gmod/Player:StripWeapon
2170
2431
  */
2171
2432
  StripWeapon(self: Player, weapon: string): void;
2433
+
2172
2434
  /**
2173
2435
  * Removes all weapons from a certain player
2174
2436
  * @realm server
2175
2437
  * @source https://wiki.facepunch.com/gmod/Player:StripWeapons
2176
2438
  */
2177
2439
  StripWeapons(self: Player): void;
2440
+
2178
2441
  /**
2179
2442
  * Prevents a hint from showing up.
2180
2443
  *
@@ -2186,6 +2449,7 @@ interface Player extends Entity {
2186
2449
  * @source https://wiki.facepunch.com/gmod/Player:SuppressHint
2187
2450
  */
2188
2451
  SuppressHint(self: Player, name: string): void;
2452
+
2189
2453
  /**
2190
2454
  * Attempts to switch the player weapon to the one specified in the "cl_defaultweapon" convar, if the player does not own the specified weapon nothing will happen.
2191
2455
  *
@@ -2195,6 +2459,7 @@ interface Player extends Entity {
2195
2459
  * @source https://wiki.facepunch.com/gmod/Player:SwitchToDefaultWeapon
2196
2460
  */
2197
2461
  SwitchToDefaultWeapon(self: Player): void;
2462
+
2198
2463
  /**
2199
2464
  * Returns the player's team ID, set by [Player:SetTeam](https://wiki.facepunch.com/gmod/Player:SetTeam)
2200
2465
  *
@@ -2204,6 +2469,7 @@ interface Player extends Entity {
2204
2469
  * @source https://wiki.facepunch.com/gmod/Player:Team
2205
2470
  */
2206
2471
  Team(self: Player): number;
2472
+
2207
2473
  /**
2208
2474
  * Returns the time in seconds since the player connected.
2209
2475
  *
@@ -2212,6 +2478,7 @@ interface Player extends Entity {
2212
2478
  * @source https://wiki.facepunch.com/gmod/Player:TimeConnected
2213
2479
  */
2214
2480
  TimeConnected(self: Player): number;
2481
+
2215
2482
  /**
2216
2483
  * Performs a trace hull and applies damage to the entities hit, returns the first entity hit.
2217
2484
  *
@@ -2222,12 +2489,14 @@ interface Player extends Entity {
2222
2489
  * @source https://wiki.facepunch.com/gmod/Player:TraceHullAttack
2223
2490
  */
2224
2491
  TraceHullAttack(self: Player, startPos: Vector, endPos: Vector, mins: Vector, maxs: Vector, damage: number, damageFlags: number, damageForce: number, damageAllNPCs: boolean): Entity;
2492
+
2225
2493
  /**
2226
2494
  * Translates [Enums/ACT](https://wiki.facepunch.com/gmod/Enums/ACT) according to the holdtype of players currently held weapon.
2227
2495
  * @realm shared
2228
2496
  * @source https://wiki.facepunch.com/gmod/Player:TranslateWeaponActivity
2229
2497
  */
2230
2498
  TranslateWeaponActivity(self: Player, act: number): number;
2499
+
2231
2500
  /**
2232
2501
  * Unlocks the player movement if locked previously.
2233
2502
  *
@@ -2237,6 +2506,7 @@ interface Player extends Entity {
2237
2506
  * @source https://wiki.facepunch.com/gmod/Player:UnLock
2238
2507
  */
2239
2508
  UnLock(self: Player): void;
2509
+
2240
2510
  /**
2241
2511
  * Removes the player from the spectate mode entirely.
2242
2512
  *
@@ -2246,12 +2516,14 @@ interface Player extends Entity {
2246
2516
  * @source https://wiki.facepunch.com/gmod/Player:UnSpectate
2247
2517
  */
2248
2518
  UnSpectate(self: Player): void;
2519
+
2249
2520
  /**
2250
2521
  * Unfreezes all objects the player has frozen with their Physics Gun. Same as double pressing R while holding Physics Gun.
2251
2522
  * @realm shared
2252
2523
  * @source https://wiki.facepunch.com/gmod/Player:UnfreezePhysicsObjects
2253
2524
  */
2254
2525
  UnfreezePhysicsObjects(self: Player): void;
2526
+
2255
2527
  /**
2256
2528
  * Returns a 32 bit integer that remains constant for a player across joins/leaves and across different servers. This can be used when a string is inappropriate - e.g. in a database primary key.
2257
2529
  *
@@ -2266,6 +2538,7 @@ interface Player extends Entity {
2266
2538
  * @deprecated **This function has collisions,** where more than one player can have the same UniqueID. It is **highly** recommended to use Player:SteamID64, Player:SteamID or Player:AccountID instead, which are guaranteed to be unique to each player.
2267
2539
  */
2268
2540
  UniqueID(self: Player): number;
2541
+
2269
2542
  /**
2270
2543
  * Returns a table that will stay allocated for the specific player serverside between connects until the server shuts down or change map. On client it has no such special behavior.
2271
2544
  *
@@ -2276,6 +2549,7 @@ interface Player extends Entity {
2276
2549
  * @source https://wiki.facepunch.com/gmod/Player:UniqueIDTable
2277
2550
  */
2278
2551
  UniqueIDTable(self: Player, key: any): table;
2552
+
2279
2553
  /**
2280
2554
  * Returns the player's user ID. This number will always be unique, but will reset if the player reconnects. (Always increments for each connecting player)
2281
2555
  *
@@ -2285,6 +2559,7 @@ interface Player extends Entity {
2285
2559
  * @source https://wiki.facepunch.com/gmod/Player:UserID
2286
2560
  */
2287
2561
  UserID(self: Player): number;
2562
+
2288
2563
  /**
2289
2564
  * Simulates a push on the client's screen. This **adds** view punch velocity, and does not reset the current view punch angle, for which you can use [Player:SetViewPunchAngles](https://wiki.facepunch.com/gmod/Player:SetViewPunchAngles).
2290
2565
  *
@@ -2295,12 +2570,14 @@ interface Player extends Entity {
2295
2570
  * @source https://wiki.facepunch.com/gmod/Player:ViewPunch
2296
2571
  */
2297
2572
  ViewPunch(self: Player, punchAngle: Angle): void;
2573
+
2298
2574
  /**
2299
2575
  * Resets the player's view punch (and the view punch velocity, read more at [Player:ViewPunch](https://wiki.facepunch.com/gmod/Player:ViewPunch)) effect back to normal.
2300
2576
  * @realm shared
2301
2577
  * @source https://wiki.facepunch.com/gmod/Player:ViewPunchReset
2302
2578
  */
2303
2579
  ViewPunchReset(self: Player, tolerance?: number): void;
2580
+
2304
2581
  /**
2305
2582
  * Returns the players voice volume, how loud the player's voice communication currently is, as a number in range of [0,1].
2306
2583
  *
@@ -2316,286 +2593,6 @@ interface Player extends Entity {
2316
2593
  */
2317
2594
  declare player: PlayerLib;
2318
2595
 
2319
-
2320
-
2321
-
2322
-
2323
-
2324
-
2325
-
2326
-
2327
-
2328
-
2329
-
2330
-
2331
-
2332
-
2333
-
2334
-
2335
-
2336
-
2337
-
2338
-
2339
-
2340
-
2341
-
2342
-
2343
-
2344
-
2345
-
2346
-
2347
-
2348
-
2349
-
2350
-
2351
-
2352
-
2353
-
2354
-
2355
-
2356
-
2357
-
2358
-
2359
-
2360
-
2361
-
2362
-
2363
-
2364
-
2365
-
2366
-
2367
-
2368
-
2369
-
2370
-
2371
-
2372
-
2373
-
2374
-
2375
-
2376
-
2377
-
2378
-
2379
-
2380
-
2381
-
2382
-
2383
-
2384
-
2385
-
2386
-
2387
-
2388
-
2389
-
2390
-
2391
-
2392
-
2393
-
2394
-
2395
-
2396
-
2397
-
2398
-
2399
-
2400
-
2401
-
2402
-
2403
-
2404
-
2405
-
2406
-
2407
-
2408
-
2409
-
2410
-
2411
-
2412
-
2413
-
2414
-
2415
-
2416
-
2417
-
2418
-
2419
-
2420
-
2421
-
2422
-
2423
-
2424
-
2425
-
2426
-
2427
-
2428
-
2429
-
2430
-
2431
-
2432
-
2433
-
2434
-
2435
-
2436
-
2437
-
2438
-
2439
-
2440
-
2441
-
2442
-
2443
-
2444
-
2445
-
2446
-
2447
-
2448
-
2449
-
2450
-
2451
-
2452
-
2453
-
2454
-
2455
-
2456
-
2457
-
2458
-
2459
-
2460
-
2461
-
2462
-
2463
-
2464
-
2465
-
2466
-
2467
-
2468
-
2469
-
2470
-
2471
-
2472
-
2473
-
2474
-
2475
-
2476
-
2477
-
2478
-
2479
-
2480
-
2481
-
2482
-
2483
-
2484
-
2485
-
2486
-
2487
-
2488
-
2489
-
2490
-
2491
-
2492
-
2493
-
2494
-
2495
-
2496
-
2497
-
2498
-
2499
-
2500
-
2501
-
2502
-
2503
-
2504
-
2505
-
2506
-
2507
-
2508
-
2509
-
2510
-
2511
-
2512
-
2513
-
2514
-
2515
-
2516
-
2517
-
2518
-
2519
-
2520
-
2521
-
2522
-
2523
-
2524
-
2525
-
2526
-
2527
-
2528
-
2529
-
2530
-
2531
-
2532
-
2533
-
2534
-
2535
-
2536
-
2537
-
2538
-
2539
-
2540
-
2541
-
2542
-
2543
-
2544
-
2545
-
2546
-
2547
-
2548
-
2549
-
2550
-
2551
-
2552
-
2553
-
2554
-
2555
-
2556
-
2557
-
2558
-
2559
-
2560
-
2561
-
2562
-
2563
-
2564
-
2565
-
2566
-
2567
-
2568
-
2569
-
2570
-
2571
-
2572
-
2573
-
2574
-
2575
-
2576
-
2577
-
2578
-
2579
-
2580
-
2581
-
2582
-
2583
-
2584
-
2585
-
2586
-
2587
-
2588
-
2589
-
2590
-
2591
-
2592
-
2593
-
2594
-
2595
-
2596
-
2597
-
2598
-
2599
2596
  interface PlayerLib {
2600
2597
  /**
2601
2598
  * Similar to the serverside command "bot", this function creates a new Player bot with the given name. This bot will not obey to the usual `bot_*` commands, and it's the same bot base used in TF2 and CS:S.
@@ -2613,6 +2610,7 @@ interface PlayerLib {
2613
2610
  * @source https://wiki.facepunch.com/gmod/player.CreateNextBot
2614
2611
  */
2615
2612
  CreateNextBot(botName: string): Player;
2613
+
2616
2614
  /**
2617
2615
  * Gets all the current players in the server (not including connecting clients).
2618
2616
  *
@@ -2625,12 +2623,14 @@ interface PlayerLib {
2625
2623
  * @source https://wiki.facepunch.com/gmod/player.GetAll
2626
2624
  */
2627
2625
  GetAll(): Player[];
2626
+
2628
2627
  /**
2629
2628
  * Returns a table of all bots on the server.
2630
2629
  * @realm shared
2631
2630
  * @source https://wiki.facepunch.com/gmod/player.GetBots
2632
2631
  */
2633
2632
  GetBots(): Player[];
2633
+
2634
2634
  /**
2635
2635
  * Tried to get the player with the specified [Player:AccountID](https://wiki.facepunch.com/gmod/Player:AccountID).
2636
2636
  * **WARNING**: Internally this function iterates over all players in the server, meaning it can be quite expensive in a performance-critical context.
@@ -2640,6 +2640,7 @@ interface PlayerLib {
2640
2640
  * @source https://wiki.facepunch.com/gmod/player.GetByAccountID
2641
2641
  */
2642
2642
  GetByAccountID(accountID: number): Player | boolean;
2643
+
2643
2644
  /**
2644
2645
  * Gets the player with the specified connection ID.
2645
2646
  *
@@ -2654,6 +2655,7 @@ interface PlayerLib {
2654
2655
  * @source https://wiki.facepunch.com/gmod/player.GetByID
2655
2656
  */
2656
2657
  GetByID(connectionID: number): Player | NULL;
2658
+
2657
2659
  /**
2658
2660
  * Gets the player with the specified SteamID.
2659
2661
  * **WARNING**: Internally this function iterates over all players in the server, meaning it can be quite expensive in a performance-critical context.
@@ -2663,6 +2665,7 @@ interface PlayerLib {
2663
2665
  * @source https://wiki.facepunch.com/gmod/player.GetBySteamID
2664
2666
  */
2665
2667
  GetBySteamID(steamID: string): Player | boolean;
2668
+
2666
2669
  /**
2667
2670
  * Gets the player with the specified SteamID64.
2668
2671
  * **WARNING**: Internally this function iterates over all players in the server, meaning it can be quite expensive in a performance-critical context.
@@ -2672,6 +2675,7 @@ interface PlayerLib {
2672
2675
  * @source https://wiki.facepunch.com/gmod/player.GetBySteamID64
2673
2676
  */
2674
2677
  GetBySteamID64(steamID64: string): Player | boolean;
2678
+
2675
2679
  /**
2676
2680
  * Gets the player with the specified uniqueID (not recommended way to identify players).
2677
2681
  *
@@ -2685,6 +2689,7 @@ interface PlayerLib {
2685
2689
  * @deprecated Use player.GetBySteamID64, player.GetBySteamID or player.GetByAccountID to get a player by a unique identifier instead.
2686
2690
  */
2687
2691
  GetByUniqueID(uniqueID: string): Player | boolean;
2692
+
2688
2693
  /**
2689
2694
  * Returns the active player count.
2690
2695
  *
@@ -2697,6 +2702,7 @@ interface PlayerLib {
2697
2702
  * @source https://wiki.facepunch.com/gmod/player.GetCount
2698
2703
  */
2699
2704
  GetCount(): number;
2705
+
2700
2706
  /**
2701
2707
  * Returns the amount of players connecting to the server, but not yet spawned in.
2702
2708
  *
@@ -2707,6 +2713,7 @@ interface PlayerLib {
2707
2713
  * @source https://wiki.facepunch.com/gmod/player.GetCountConnecting
2708
2714
  */
2709
2715
  GetCountConnecting(): number;
2716
+
2710
2717
  /**
2711
2718
  * Returns a table containing all human players (non-bot/AI).
2712
2719
  *
@@ -2718,6 +2725,7 @@ interface PlayerLib {
2718
2725
  * @source https://wiki.facepunch.com/gmod/player.GetHumans
2719
2726
  */
2720
2727
  GetHumans(): Player[];
2728
+
2721
2729
  /**
2722
2730
  * Returns a stateless iterator for all players on the server, intended for use
2723
2731
  * in generic for-loops. Uses cached Lua values, so it is more efficient than
@@ -2727,16 +2735,3 @@ interface PlayerLib {
2727
2735
  */
2728
2736
  Iterator(): (((tbl: any, prev?: number) => (number, Player)), Player[], number);
2729
2737
  }
2730
-
2731
-
2732
-
2733
-
2734
-
2735
-
2736
-
2737
-
2738
-
2739
-
2740
-
2741
-
2742
-