Multi Theft Auto: Wiki - User contributions [en]

OnPlayerQuit

2015-01-14T12:59:36Z

Jack Johnson: Shortened down the code

__NOTOC__
{{Server event}}
This event is triggered when a player disconnects from the server.

==Parameters==
<syntaxhighlight lang="lua">
string quitType, string reason, element responsibleElement
</syntaxhighlight>

*'''quitType''': How the player left.
This argument can be:
* "Unknown"
* "Quit"
* "Kicked"
* "Banned"
* "Bad Connection"
* "Timed out"

{{New feature|3|1.0|
*'''reason''': If the player was kicked or banned, the reason given goes here. If the player was '''not''' kicked or banned, this will be false.

*'''responsibleElement''': The element that was responsible for kicking or banning the player. This is commonly another player, but can also be the console element.
}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that left the server.

==Example==
This example gets the quitting client's name and outputs that he is gone

<syntaxhighlight lang="lua">
-- we register quitPlayer as a handler for the event
function quitPlayer ( quitType )
-- send the message to the server telling players that the player has left.
outputChatBox ( getPlayerName(source).. " has left the server (" .. quitType .. ")" )
end
addEventHandler ( "onPlayerQuit", getRootElement(), quitPlayer )
</syntaxhighlight>

{{See also/Server event|Player events}}

GetMaxPlayers

2015-01-14T12:56:21Z

Jack Johnson: Shortened down the code

__NOTOC__
{{Server function}}
This function returns the maximum number of player slots on the server.

==Syntax==
<syntaxhighlight lang="lua">int getMaxPlayers ()</syntaxhighlight>

===Returns===
Returns the maximum number of players allowed on the server.

==Example==
This example outputs the current number of players together with the maximum number of players when a player joins.
<syntaxhighlight lang="lua">
function showPlayers()
outputChatBox("There are "..getPlayerCount().."/"..getMaxPlayers().." players playing.",source) --output a message to the joined player informing the player count and max players.
end
addEventHandler("onPlayerJoin",root,showPlayers) --Add an event handler to call the function when a player joins.
</syntaxhighlight>

==See Also==
{{Server functions}}

OutputConsole

2015-01-14T12:53:52Z

Jack Johnson: Shortened down the function by taking advantage of the command variable.

{{Server client function}}
__NOTOC__
This outputs the specified text string to the console window (accessed with F8 or ~ key). It can be specified as a message to certain player(s) or all players.

==Syntax==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool outputConsole ( string text )</syntaxhighlight>

===Required Arguments===
*'''text:''' The text string that you wish to send to the console window
</section>

<section name="Server" class="server" show="true"><syntaxhighlight lang="lua">bool outputConsole ( string text, [ element visibleTo=getRootElement() ] )</syntaxhighlight>

===Required Arguments===
*'''text:''' The text string that you wish to send to the console window

===Optional Arguments===
*'''visibleTo:''' This specifies who the chat is visible to. Any players in this element will see the chat message. See [[visibility]].
{{Note|'''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.}}</section>

==Example==
<section name="Server" class="server" show="true">This code creates two console commands. One, 'public', will post a message in the consoles of all players, and the other, 'private', will post a message in only the console of the player that executed the command.
<syntaxhighlight lang="lua">
function message(player,command)
if command == "public" then
outputConsole("Public console message")
else
outputConsole("Private console message",player)
end
end
addCommandHandler("public",message)
addCommandHandler("private",message)
</syntaxhighlight></section>

==See Also==
{{Server functions}}