GetPlayersInRange3D: Difference between revisions
From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPlayersInRange3D(x, y, z, range)}} {{FuncParameters}} {{FuncParam|x|__EDIT_ME__}} {{FuncParam|y..." |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Info|Function|Server|1.0}} | {{Info|Function|Server|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Gets the players in the specified range of XYZ in a table. An important function which replaces the use of looping through all players and then checking if they are in the specified range.}} | ||
{{FuncSyntax|GetPlayersInRange3D(x, y, z, range)}} | {{FuncSyntax|GetPlayersInRange3D(x, y, z, range)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|x| | {{FuncParam|x|The X axis}} | ||
{{FuncParam|y| | {{FuncParam|y|The Y axis}} | ||
{{FuncParam|z| | {{FuncParam|z|The Z axis}} | ||
{{FuncParam|range| | {{FuncParam|range|The range}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns a table with the player identifiers in range.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang='Lua'> | |||
for k, v in pairs(GetPlayersInRange3D(x, y, z, 1000)) do | |||
AddPlayerChat(v, "HEY YOU ARE IN THE RANGE OF THIS POINT.") | |||
end | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{ServerPlayerFunctions}} | |||
Latest revision as of 18:31, 30 August 2020
Description
Gets the players in the specified range of XYZ in a table. An important function which replaces the use of looping through all players and then checking if they are in the specified range.
Syntax
GetPlayersInRange3D(x, y, z, range)
Parameters
- x
The X axis - y
The Y axis - z
The Z axis - range
The range
Return Value
- Returns a table with the player identifiers in range.
Example
for k, v in pairs(GetPlayersInRange3D(x, y, z, 1000)) do
AddPlayerChat(v, "HEY YOU ARE IN THE RANGE OF THIS POINT.")
end
See also
- GetPlayerBySteamId
- SetPlayerRagdoll
- SetPlayerDimension
- GetPlayerDimension
- SetPlayerPropertyValue
- GetPlayerPropertyValue
- IsValidPlayer
- GetPlayerCount
- GetAllPlayers
- GetNearestPlayer2D
- GetPlayersInRange2D
- GetPlayersInRange3D
- GetStreamedPlayersForPlayer
- SetPlayerName
- GetPlayerName
- GetPlayerSteamId
- GetPlayerNetworkStats
- SetPlayerSpawnLocation
- IsPlayerStreamedIn
- SetPlayerVoiceRange
- SetPlayerVoiceChannel
- IsPlayerVoiceChannel
- SetPlayerVoiceEnabled
- IsPlayerVoiceEnabled
- IsPlayerTalking
- AddPlayerChat
- AddPlayerChatRange
- AddPlayerChatAll
- GetPlayerState
- GetPlayerMovementMode
- GetPlayerMovementSpeed
- IsPlayerAiming
- IsPlayerReloading
- GetPlayerVehicle
- GetPlayerVehicleSeat
- SetPlayerInVehicle
- RemovePlayerFromVehicle
- SetPlayerLocation
- GetPlayerLocation
- SetPlayerWeaponStat
- SetPlayerWeapon
- GetPlayerWeapon
- GetPlayerEquippedWeaponSlot
- EquipPlayerWeaponSlot
- GetPlayerEquippedWeapon
- SetPlayerHeading
- GetPlayerHeading
- SetPlayerSpectate
- IsPlayerDead
- SetPlayerHealth
- GetPlayerHealth
- SetPlayerArmor
- GetPlayerArmor
- SetPlayerRespawnTime
- GetPlayerRespawnTime
- GetPlayerIP
- GetPlayerPing
- KickPlayer
- GetPlayerLocale
- GetPlayerGUID
- GetPlayerGameVersion
- SetPlayerAnimation
- AttachPlayerParachute
- SetPlayerHeadSize
- GetPlayerHeadSize
