GetPCPlayerName

From NWN Lexicon
Jump to: navigation, search



GetPCPlayerName(object)

Retrieves the login name of the player of a PC.

string GetPCPlayerName(
    object oPlayer
);

Parameters

oPlayer

The player whose controller's login name is to be retrieved.


Description

Returns the login account name of the player controlling oPlayer.



Known Bugs

Not a bug, but a caveat

OnClientLeave, the PC object (GetExitingObject) is still valid, but the player object (i.e. the human being logged into the server) is not. This means that there are a few things you can't do OnClientLeave. Namely, the GetPCPlayerName, GetPCIPAddress, and GetPCPublicCDKey will not work, since the player is no longer around to get that information from. This can be worked around by storing them as local strings on the PC, for instance OnClientEnter. See workaround below.


Version

1.61

Example

//Workaround for the caveat above
 
void main()
{
object oPC=GetEnteringObject();
string sPlayerName=GetPCPlayerName(oPC);
string sIP=GetPCIPAddress(oPC);
string sKey=GetPCPublicCDKey(oPC);
SetLocalString(oPC, "player_name", sPlayerName);
SetLocalString(oPC, "player_ip", sIP);
SetLocalString(oPC, "player_cdkey", sKey);
}

See Also



 author: Sarev0k, editor: Lilac Soul, additional contributor(s): Sam Featherston, Lilac Soul