GetPlayerFromName: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
 
Line 2: Line 2:


==Syntax==
==Syntax==
<syntaxhighlight lang="C#" >Client NAPI.Player.GetPlayerFromName(string name);</syntaxhighlight>
<syntaxhighlight lang="C#" >Player NAPI.Player.GetPlayerFromName(string name);</syntaxhighlight>


'''Required Arguments'''
'''Required Arguments'''

Latest revision as of 21:49, 22 December 2022

This method returns a Player param from a given player name, returns null if the player name does not exist.

Syntax

Player NAPI.Player.GetPlayerFromName(string name);

Required Arguments

  • name: parameter input should be in string type.

NOTE: This function returns data in Player type.

Usage example

Check if the name Bob exists.

    bool exists = NAPI.Player.GetPlayerFromName("Bob") != null;
    if(exists) NAPI.Chat.SendChatMessageToAll("BOB EXISTS!!!");

Kick the Player if their name exists.

    string name = "Bob";
    Player target = NAPI.Player.GetPlayerFromName(name);
    bool exists = target != null;
    if (exists) NAPI.Player.KickPlayer(target, "Flock you Bob!");