LogoutPlayer: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with "Logs a player out of ACL. ==Syntax== {{#tag:pre|void {{Template:CSharp_Serverside_namespace}}ACL.LogoutPlayer(Client player);}} === Required Arguments === *'''player:''' par...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Logs a player out of ACL.
Logs a player out of ACL.


==Syntax==
 
{{CSharpContainer|
{{#tag:pre|void {{Template:CSharp_Serverside_namespace}}ACL.LogoutPlayer(Client player);}}
{{#tag:pre|void {{Template:CSharp_Serverside_namespace}}ACL.LogoutPlayer(Client player);}}


=== Required Arguments ===
{{Parameters}}
*'''player:''' parameter input should be in '''Client''' type
*'''player:''' parameter input should be in '''Client''' type


==Example==
{{CSharpContainer|
{{Parameters}}
*'''player:''' parameter input should be in '''Client''' type


{{Example}}
{{Example}}
<syntaxhighlight lang="C#">
{{#tag:syntaxhighlight|
[Command("logout", ACLRequired = true)]
[Command("logout", ACLRequired = true)]
public void LogoutCommand(Client sender)
public void LogoutCommand(Client sender)
{
{
     if (!NAPI.ACL.IsPlayerLoggedIn(sender))  
     if (!{{Template:CSharp_Serverside_namespace}}ACL.IsPlayerLoggedIn(sender))  
     {
     {
         sender.SendChatMessage("~r~You are not logged in.");
         sender.SendChatMessage("~r~You are not logged in.");
Line 23: Line 20:
     }
     }
    
    
     NAPI.ACL.LogoutPlayer(sender);
     {{Template:CSharp_Serverside_namespace}}ACL.LogoutPlayer(sender);
     sender.SendChatMessage("~g~You have been logged out.");
     sender.SendChatMessage("~g~You have been logged out.");
}
}
</syntaxhighlight>
|lang=csharp}}
}}
}}


[[Category:Serverside API]]
[[Category:Serverside API]]

Latest revision as of 18:16, 28 November 2019

Logs a player out of ACL.


C# Syntax

void NAPI.ACL.LogoutPlayer(Client player);

Parameters

  • player: parameter input should be in Client type


Example

[Command("logout", ACLRequired = true)]
public void LogoutCommand(Client sender)
{
    if (!NAPI.ACL.IsPlayerLoggedIn(sender)) 
    {
        sender.SendChatMessage("~r~You are not logged in.");
        return;
    }
  
    NAPI.ACL.LogoutPlayer(sender);
    sender.SendChatMessage("~g~You have been logged out.");
}