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
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Toggle the player spectate mode.}}


{{FuncSyntax|SetPlayerSpectate(player, bSpectate)}}
{{FuncSyntax|SetPlayerSpectate(player, bSpectate)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}
{{FuncParam|bSpectate|__EDIT_ME__}}
{{FuncParam|bSpectate|The boolean status.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns nothing.}}


== Example ==
== Example ==
__EDIT_ME__
<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}}
__EDIT_ME__
{{ServerPlayerFunctions}}

Latest revision as of 14:50, 26 June 2021

SetPlayerSpectate

Type: Function
Context: Server
Introduced: v1.0

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)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetPlayerSpectate&oldid=4857"