GetAllPlayersInBox: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Gets a table of players that are inside a specific box area.}} | ||
{{FuncSyntax|GetAllPlayersInBox(x, y, z, bx, by, bz [, bIncludeSelf])}} | {{FuncSyntax|GetAllPlayersInBox(x, y, z, bx, by, bz [, bIncludeSelf])}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|x| | {{FuncParam|x|The box X location.}} | ||
{{FuncParam|y| | {{FuncParam|y|The box Y location.}} | ||
{{FuncParam|z| | {{FuncParam|z|The box Z location.}} | ||
{{FuncParam|bx| | {{FuncParam|bx|The box X extent.}} | ||
{{FuncParam|by| | {{FuncParam|by|The box Y extent.}} | ||
{{FuncParam|bz | | {{FuncParam|bz|The box Z extent.}} | ||
{{FuncParamOptional|bIncludeSelf| | {{FuncParamOptional|bIncludeSelf|Whether to check for the local player as well, default: '''true'''}} | ||
{{FuncReturnValue|Returns a table with player identifiers as value.}} | {{FuncReturnValue|Returns a table with player identifiers as value.}} | ||
Latest revision as of 19:53, 30 August 2020
Description
Gets a table of players that are inside a specific box area.
Syntax
GetAllPlayersInBox(x, y, z, bx, by, bz [, bIncludeSelf])
Parameters
- x
The box X location. - y
The box Y location. - z
The box Z location. - bx
The box X extent. - by
The box Y extent. - bz
The box Z extent. - bIncludeSelf (optional)
Whether to check for the local player as well, default: true
Return Value
- Returns a table with player identifiers as value.
Example
__EDIT_ME__
See also
__EDIT_ME__
