RustTip

OnFindSpawnPoint

OxideCarbonPlayer

Called when find spawn point occurs.

object OnFindSpawnPoint(BasePlayer forPlayer, ulong teamId)
Works — the game method in this build is the one the hook was written for.

Parameters

forPlayer
BasePlayer
teamId
ulong

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object OnFindSpawnPoint(BasePlayer forPlayer, ulong teamId)
{
    Puts("OnFindSpawnPoint");

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

    // to affect the game:
    // return default(BasePlayer.SpawnPoint); // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)
BasePlayer.SpawnPoint ServerMgr.FindSpawnPoint(BasePlayer, ulong)

Passes: BasePlayer forPlayer, ulong teamId

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustParamsAssembly-CSharp.dll

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

public static BasePlayer.SpawnPoint FindSpawnPoint(BasePlayer forPlayer = null, ulong teamId = 0uL)
{
	object returnvar = Interface.CallHook("OnFindSpawnPoint", forPlayer, teamId);
	if (returnvar is BasePlayer.SpawnPoint)
	{
		return (BasePlayer.SpawnPoint)returnvar;
	}
	bool flag = false;
	if (forPlayer != null && forPlayer.IsInTutorial)
	{
		TutorialIsland currentTutorialIsland = forPlayer.GetCurrentTutorialIsland();
// …

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.