Skip to content

OnMessagePlayer

Called when a message is sent to a player

Usage

  • Return a non-null value to override default behavior

Example Autogenerated

csharp
private void OnMessagePlayer( string msg, BasePlayer instance )
{
    Puts( "OnMessagePlayer works!" );
}
csharp
private object OnMessagePlayer( string formatted, BasePlayer player, ulong userId )
{
    Puts( "OnMessagePlayer works!" );
    return null;
}

Location

  • BasePlayer::ChatMessage(string msg)
  • Player::Message(BasePlayer player, string message, string prefix, ulong userId, object[] args params)
csharp
//---
{
	if (!base.isServer)
	{
		return;
	}
	if (Interface.CallHook("OnMessagePlayer", msg, this) != null)
	{
		return;
	}
	this.SendConsoleCommand("chat.add", new object[]
	{
//---
csharp
public void Message(BasePlayer player, string message, string prefix, ulong userId = 0, params object[] args)
{
	if (string.IsNullOrEmpty(message))
	{
		return;
	}

	message = args.Length > 0 ? string.Format(Formatter.ToUnity(message), args) : Formatter.ToUnity(message);
	string formatted = prefix != null ? $"{prefix} {message}" : message;
	if (Interface.CallHook("OnMessagePlayer", formatted, player, userId) != null)
	{
		return;
	}
	player.SendConsoleCommand("chat.add", 2, userId, formatted);
}

Released under the MIT License.