LogOut: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: bool logOut ( player ))
 
m (Добавление языков)
 
(18 intermediate revisions by 12 users not shown)
Line 1: Line 1:
bool logOut ( player )
__NOTOC__
{{Server function}}
This function logs the given player out of his current [[account]].
 
==Syntax==
<syntaxhighlight lang="lua">
bool logOut ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:logOut}}
 
===Required Arguments===
*'''thePlayer:''' The player to log out of his current account
 
===Returns===
Returns ''true'' if the player was successfully logged out, ''false'' or ''nil'' if it failed for some reason, ie. the player was never logged in.
 
==Example==
This example logs every player out of their account when the resource is (re)started. This would be handy for resources that show a login screen onClientResourceStart.
<syntaxhighlight lang="lua">
function logoutAll ()
local players = getElementsByType ( "player" ) -- Get every player
for k, player in ipairs ( players ) do -- For every player do the following...
account = getPlayerAccount ( player ) -- Get every player's account
if ( not isGuestAccount ( account ) ) then -- For every player that's logged in....
logOut ( player ) -- Log them out.
end
end
end
-- Trigger it when the resource (re)starts
addEventHandler ( "onResourceStart", getResourceRootElement(), logoutAll )</syntaxhighlight>
 
==See Also==
{{Account_functions}}
 
[[en:logOut]]
[[ru:logOut]]
[[es:logOut]]
[[zh-cn:logOut]]

Latest revision as of 15:06, 12 April 2021

This function logs the given player out of his current account.

Syntax

bool logOut ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:logOut(...)


Required Arguments

  • thePlayer: The player to log out of his current account

Returns

Returns true if the player was successfully logged out, false or nil if it failed for some reason, ie. the player was never logged in.

Example

This example logs every player out of their account when the resource is (re)started. This would be handy for resources that show a login screen onClientResourceStart. 

function logoutAll ()
	local players = getElementsByType ( "player" ) -- Get every player
		for k, player in ipairs ( players ) do -- For every player do the following...
			account = getPlayerAccount ( player ) -- Get every player's account
				if ( not isGuestAccount ( account ) ) then -- For every player that's logged in....
					logOut ( player ) -- Log them out.
				end
		end
end
 -- Trigger it when the resource (re)starts
addEventHandler ( "onResourceStart", getResourceRootElement(), logoutAll )

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/LogOut?oldid=70105"