SetPlayerSpectate: Difference between revisions
From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetPlayerSpectate(player, bSpectate)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncP..." |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Server|1.0}} | {{Info|Function|Server|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Toggle the player spectate mode.}} | ||
{{FuncSyntax|SetPlayerSpectate(player, bSpectate)}} | {{FuncSyntax|SetPlayerSpectate(player, bSpectate)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|player| | {{FuncParam|player|The player identifier.}} | ||
{{FuncParam|bSpectate| | {{FuncParam|bSpectate|The boolean status.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|This function returns nothing.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
function cmd_spec(player, disable) | |||
local _disable = false | |||
if disable ~= nil then | |||
_disable = true | |||
end | |||
_disable = not _disable | |||
SetPlayerSpectate(player, _disable) | |||
end | |||
AddCommand("spec", cmd_spec) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:PlayerFunctions}} | |||
Revision as of 15:36, 19 November 2019
Description
Toggle the player spectate mode.
Syntax
SetPlayerSpectate(player, bSpectate)
Parameters
- player
The player identifier. - bSpectate
The boolean status.
Return Value
- This function returns nothing.
Example
function cmd_spec(player, disable)
local _disable = false
if disable ~= nil then
_disable = true
end
_disable = not _disable
SetPlayerSpectate(player, _disable)
end
AddCommand("spec", cmd_spec)
