OnPlayerChangeNick: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Issues: add new feature)
Line 9: Line 9:
*'''oldNick:''' the nickname the player had before.
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.6|
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}
|9765}}

Revision as of 09:26, 22 October 2016

This event is triggered when a player changes his nickname.

Parameters

string oldNick, string newNick, bool changedByUser
  • oldNick: the nickname the player had before.
  • newNick: the new nickname of the player.
  • changedByUser: whether the name was changed using setPlayerName or by the user

Source

The source of this event is the player that changed his nick

Cancel effect

Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

Example

function nickChangeHandler(oldNick, newNick)
    -- check if there's account with newNick as username
    if getAccount(newNick) then
        outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
        outputChatBox("Please choose another one.", source, 0, 255, 0)
        -- cancel the event to prevent the nick from being changed
        cancelEvent()
    end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)

This example displays a message to everyone every time player changed his nick 

function nickChangeHandler(oldNick, newNick)
outputChatBox(oldNick.." is now known as "..newNick, getRootElement(), 255, 100, 100) -- display the message
end
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler) -- add an event handler

Issues

Template:GH Issue
Issue ID Description
#7362 onPlayerChangeNick triggered when nick doesn't changed

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerChangeNick?oldid=49576"