KickPlayer: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|KickPlayer(player, reason)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncParam|reaso..."
 
No edit summary
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Kicks a player with a reason, colors are '''not''' supported.}}


{{FuncSyntax|KickPlayer(player, reason)}}
{{FuncSyntax|KickPlayer(player, reason)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}
{{FuncParam|reason|__EDIT_ME__}}
{{FuncParam|reason|The reason}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function doesn't have a return value.}}


== Example ==
== Example ==

Revision as of 19:25, 28 September 2019

KickPlayer

Type: Function
Context: Server
Introduced: v1.0

Description

Kicks a player with a reason, colors are not supported.

Syntax

KickPlayer(player, reason)

Parameters

  • player
    The player identifier.
  • reason
    The reason

Return Value

  • This function doesn't have a return value.

Example

__EDIT_ME__

See also

__EDIT_ME__