RustTip

OnPhoneNameUpdate

OxideCarbonElectronic

Called when a phone name is updated.

object OnPhoneNameUpdate(PhoneController phoneController, string newName, BasePlayer currentPlayer)
Works — the game method in this build is the one the hook was written for.

Parameters

phoneController
PhoneController
newName
string
currentPlayer
BasePlayer

Return value

objectReturn non-null to cancel the game action.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnPhoneNameUpdate(PhoneController phoneController, string newName, BasePlayer currentPlayer)
{
    Puts("OnPhoneNameUpdate");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // non-null cancels the game action
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)
void PhoneController.UpdatePhoneName(string)

Passes: PhoneController phoneController, string newName, BasePlayer currentPlayer

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0, this.currentPlayer)Assembly-CSharp.dll

Where it is called (this branch's game code)

public void UpdatePhoneName(string newName)
{
	if (newName.Length > 30)
	{
		newName = newName.Substring(0, 30);
	}
	if (Interface.CallHook("OnPhoneNameUpdate", this, newName, this.currentPlayer) != null)
	{
		return;
	}
	PhoneName = newName;
	baseEntity.SendNetworkUpdate();
}

Sources: Rust.opj from OxideMod/Oxide.Rust (MIT) and hook metadata of the Carbon documentation (MIT). Method code is decompiled from this branch's server.