Rename

Readme

This plugin facilitates renaming, overriding and customization of player names.

Environment Variables

Variable Name	Value	Default	Notes
NWNX_RENAME_ON_MODULE_CHAR_LIST	true or false	false	This is the listing of players from the character selection screen before entering the server. Setting the value to true overrides their names if a global rename has been set.
NWNX_RENAME_ON_PLAYER_LIST	true or false	true	Renames the player name on the player list as well.
NWNX_RENAME_ALLOW_DM	true or false	false	DM observers will see global or personal overrides as well as being able to have their own name overridden for other observers.
NWNX_RENAME_ANONYMOUS_NAME	string	Someone	When using NWNX_Rename_SetPCNameOverride with NWNX_RENAME_PLAYERNAME_ANONYMOUS this is the string used for the <PlayerName>
NWNX_RENAME_OVERWRITE_DISPLAY_NAME	true or false	false	When set to true, global overrides change the display name globally - scripts and DMs included. When set to false, then name is only changed for players. Scripts and DMs see the original names (unless NWNX_RENAME_ALLOW_DM is set).

Sample Include

#include "nwnx_rename"
// For GetPlayerID function, set to your own lib that returns the unique player ID for your PW
// Then replace GetPlayerID in this include to whatever your call is.
#include "inc_pc_db"
 
const string UNKNOWN_PLAYER = "Unknown";
const string UNKNOWN_PLAYER_PREFIX = "<c~~~>";
const string UNKNOWN_PLAYER_SUFFIX = "</c>";
 
const string RENAMED_PLAYER_PREFIX = "";
const string RENAMED_PLAYER_SUFFIX = "";
 
// This should be fired on client enter as soon as possible, it loads all
// the dynamic names for the PC for the other PCs connected and the dynamic
// name for the other PCs for the connecting PC.
void LoadNamesForPC(object oPC);
 
// Stores the info on the database
void SetDynamicNameDB(object oPC, object oOtherPC, string sName, int iDub = 0);
 
// Returns whether the PC has dubbed the target PC already
int GetDynamicNameIsDubbed(object oPC, object oTarget);
 
// We use three custom commands =c intro, =c introparty and =c introarea (20m radius)
// So the player could do =c intro Joe and the nearest player would then see the PCs
// name as Joe
void IntroducePlayers(object oPC, object oTarget, string sName, int iType = 0);
 
// Dub works the other way, a PC can dub someone what they wish to see as their
// name. =c dub Joseph (nearest PC) would then change the target's name for the
// caller to Joseph.
void DubPlayer(object oPC, object oTarget, string sName);
 
void LoadNamesForPC(object oPC)
{
    NWNX_Rename_SetPCNameOverride(oPC, UNKNOWN_PLAYER, UNKNOWN_PLAYER_PREFIX,
                UNKNOWN_PLAYER_SUFFIX, NWNX_RENAME_PLAYERNAME_OBFUSCATE);
 
    int nPCID = GetPlayerID(oPC);
    object oOtherPC = GetFirstPC();
    while (GetIsObjectValid(oOtherPC))
    {
        if (oOtherPC != oPC)
        {
            int nOtherPCID = GetPlayerID(oOtherPC);
            string sSQL = "SELECT name FROM dynamic_names WHERE pc1 = ? AND pc2 = ?";
            NWNX_SQL_PrepareQuery(sSQL);
            NWNX_SQL_PreparedInt(0, nPCID);
            NWNX_SQL_PreparedInt(1, nOtherPCID);
            NWNX_SQL_ExecutePreparedQuery();
            if (NWNX_SQL_ReadyToReadNextRow())
            {
                NWNX_SQL_ReadNextRow();
                NWNX_Rename_SetPCNameOverride(oOtherPC, NWNX_SQL_ReadDataInActiveRow(0),
                            RENAMED_PLAYER_PREFIX, RENAMED_PLAYER_SUFFIX, NWNX_RENAME_PLAYERNAME_DEFAULT, oPC);
            }
            NWNX_SQL_PrepareQuery(sSQL);
            NWNX_SQL_PreparedInt(0, nOtherPCID);
            NWNX_SQL_PreparedInt(1, nPCID);
            NWNX_SQL_ExecutePreparedQuery();
            if (NWNX_SQL_ReadyToReadNextRow())
            {
                NWNX_SQL_ReadNextRow();
                NWNX_Rename_SetPCNameOverride(oPC, NWNX_SQL_ReadDataInActiveRow(0),
                            RENAMED_PLAYER_PREFIX, RENAMED_PLAYER_SUFFIX, NWNX_RENAME_PLAYERNAME_DEFAULT, oOtherPC);
            }
        }
        oOtherPC = GetNextPC();
    }
}
 
void SetDynamicNameDB(object oPC, object oOtherPC, string sName, int iDub = 0)
{
    int nPC1ID = GetPlayerID(oPC);
    int nPC2ID = GetPlayerID(oOtherPC);
    if (nPC1ID && nPC2ID)
    {
        string sSQL = "INSERT INTO dynamic_names (pc1, pc2, name, dub) "+
                      "VALUES (?, ?, ?, ?) ON DUPLICATE KEY UPDATE name = ?, dub = ?";
        NWNX_SQL_PrepareQuery(sSQL);
        NWNX_SQL_PreparedInt(0, nPC2ID);
        NWNX_SQL_PreparedInt(1, nPC1ID);
        NWNX_SQL_PreparedString(2, sName);
        NWNX_SQL_PreparedInt(3, iDub);
        NWNX_SQL_PreparedString(4, sName);
        NWNX_SQL_PreparedInt(5, iDub);
        NWNX_SQL_ExecutePreparedQuery();
    }
}
 
int GetDynamicNameIsDubbed(object oPC, object oTarget)
{
    int nPCID = GetPlayerID(oPC);
    int nPCID2 = GetPlayerID(oTarget);
    int iDub = 0;
    string sSQL = "SELECT dub FROM dynamic_names WHERE pc1 = ? AND pc2 = ?";
    NWNX_SQL_PrepareQuery(sSQL);
    NWNX_SQL_PreparedInt(0, nPCID);
    NWNX_SQL_PreparedInt(1, nPCID2);
    NWNX_SQL_ExecutePreparedQuery();
    if (NWNX_SQL_ReadyToReadNextRow())
    {
        NWNX_SQL_ReadNextRow();
        iDub = StringToInt(NWNX_SQL_ReadDataInActiveRow(0));
    }
    return iDub;
}
 
void IntroducePlayers(object oPC, object oTarget, string sName, int iType = 0)
{
    int nPC1ID = GetPlayerID(oPC);
    int nPC2ID = GetPlayerID(oTarget);
    if (nPC1ID == nPC2ID)
        return;
    int iDub = GetDynamicNameIsDubbed(oTarget, oPC);
    string sMyName = NWNX_Rename_GetPCNameOverride(oPC, oTarget);
    if (sMyName == "")
        sMyName = "Someone";
    string sTargetName = NWNX_Rename_GetPCNameOverride(oTarget, oPC);
    if (sTargetName == "")
        sTargetName = "Someone";
    if (!iType)
        SendMessageToPC(oPC, "Introducing yourself to " + sTargetName + " as " + sName + ".");
    if (iDub)
        SendMessageToPC(oTarget, "Someone wants you to know them as " + sName + " but you've "+
                                 "already dubbed them " + sMyName + " so it's ignored.");
    else
    {
        SendMessageToPC(oTarget, sMyName + " wants you to know them as " + sName + ".");
        NWNX_Rename_SetPCNameOverride(oPC, sName, RENAMED_PLAYER_PREFIX,
                        RENAMED_PLAYER_SUFFIX, NWNX_RENAME_PLAYERNAME_DEFAULT, oTarget);
        SetDynamicNameDB(oPC, oTarget, sName);
    }
}
 
void DubPlayer(object oPC, object oTarget, string sName)
{
    string sTargetName = NWNX_Rename_GetPCNameOverride(oTarget, oPC);
    if (sTargetName == "")
        sTargetName = "Someone";
    SendMessageToPC(oPC, sTargetName + " will now be known as " + sName + " to you.");
    NWNX_Rename_SetPCNameOverride(oTarget, sName, RENAMED_PLAYER_PREFIX,
                    RENAMED_PLAYER_SUFFIX, NWNX_RENAME_PLAYERNAME_DEFAULT, oPC);
    SetDynamicNameDB(oTarget, oPC, sName, 1);
}

And a corresponding MySQL example DB structure:

CREATE TABLE `dynamic_names` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `pc1` mediumint(8) unsigned NOT NULL,
  `pc2` mediumint(8) unsigned NOT NULL,
  `name` varchar(40) NOT NULL,
  `dub` tinyint(1) DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `pair` (`pc1`,`pc2`),
  KEY `pc1` (`pc1`),
  KEY `pc2` (`pc2`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

Files
file	nwnx_rename.nss

Functions
void	NWNX_Rename_SetPCNameOverride (object oTarget, string sNewName, string sPrefix="", string sSuffix="", int iPlayerNameState=NWNX_RENAME_PLAYERNAME_DEFAULT, object oObserver=OBJECT_INVALID)
	Set a PC's character name and community name on the player list. More...
string	NWNX_Rename_GetPCNameOverride (object oTarget, object oObserver=OBJECT_INVALID)
	Gets a PC's name as overridden. More...
void	NWNX_Rename_ClearPCNameOverride (object oTarget, object oObserver=OBJECT_INVALID, int clearAll=FALSE)
	Clears an overridden PC Name. More...

Function Documentation

NWNX_Rename_SetPCNameOverride()

void NWNX_Rename_SetPCNameOverride	(	object	oTarget,
		string	sNewName,
		string	sPrefix = "",
		string	sSuffix = "",
		int	iPlayerNameState = NWNX_RENAME_PLAYERNAME_DEFAULT,
		object	oObserver = OBJECT_INVALID
	)

Set a PC's character name and community name on the player list.

Parameters

oTarget	The PC whose name is being overridden.
sNewName	The new name.
sPrefix	The prefix for their character name, sometimes used for a color code.
sSuffix	The suffix for their character name.
iPlayerNameState	How to change the Community Name, use Community Name Override Type.
oObserver	If specified, the character name will appear to that specific observer as set, this overrides a global setting.

Note

Will not persist through saving, resets or logout.

Definition at line 45 of file nwnx_rename.nss.

NWNX_Rename_GetPCNameOverride()

string NWNX_Rename_GetPCNameOverride	(	object	oTarget,
		object	oObserver = OBJECT_INVALID
	)

Gets a PC's name as overridden.

Parameters

oTarget	The PC whose name to query.
oObserver	The specific observer.

Returns

The PC's name as overridden either per observer or globally.

Note

If you wish to get a PC's true name use GetName(oPC, TRUE).

Definition at line 56 of file nwnx_rename.nss.

NWNX_Rename_ClearPCNameOverride()

void NWNX_Rename_ClearPCNameOverride	(	object	oTarget,
		object	oObserver = OBJECT_INVALID,
		int	clearAll = FALSE
	)

Clears an overridden PC Name.

Parameters

oTarget	The PC whose overridden name to clear, use OBJECT_INVALID if you're clearing all overrides for an observer.
oObserver	The observer whose overridden name of oTarget is being cleared. If oTarget is OBJECT_INVALID then all overrides are cleared.
clearAll	If true, both the global and personal overrides will be cleared for that target PC. Requires oObserver be OBJECT_INVALID.

Definition at line 64 of file nwnx_rename.nss.

Variable Documentation

NWNX_RENAME_PLAYERNAME_DEFAULT

const int NWNX_RENAME_PLAYERNAME_DEFAULT = 0

Don't rename.

Definition at line 11 of file nwnx_rename.nss.

NWNX_RENAME_PLAYERNAME_OBFUSCATE

const int NWNX_RENAME_PLAYERNAME_OBFUSCATE = 1

Generate random string for Community Name.

Definition at line 12 of file nwnx_rename.nss.

NWNX_RENAME_PLAYERNAME_OVERRIDE

const int NWNX_RENAME_PLAYERNAME_OVERRIDE = 2

Use character name specified.

Definition at line 13 of file nwnx_rename.nss.

NWNX_RENAME_PLAYERNAME_ANONYMOUS

const int NWNX_RENAME_PLAYERNAME_ANONYMOUS = 3

Use the value of the NWNX_RENAME_ANONYMOUS_NAME environment variable.

Definition at line 14 of file nwnx_rename.nss.