CanBeSplashed
OxidePlayerobject CanBeSplashed(BasePlayer basePlayer, ItemDefinition splashType, int amount)Works — the game method in this build is the one the hook was written for.
Parameters
- basePlayer
- BasePlayer
- splashType
- ItemDefinition
- amount
- int
Return value
objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.
Example
object — you can affect the game: return a value to change or cancel the action.
private object CanBeSplashed(BasePlayer basePlayer, ItemDefinition splashType, int amount)
{
Puts("CanBeSplashed");
// change nothing — the game continues as usual
return null;
// to affect the game:
// return null; // null — the game continues as usual
}Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.
Injection point
Rust.opj (Oxide)
bool BasePlayer.WantsSplash(ItemDefinition, int)
Passes: BasePlayer basePlayer, ItemDefinition splashType, int amount
WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0, a1)Assembly-CSharp.dll
Where it is called (this branch's game code)
public bool WantsSplash(ItemDefinition splashType, int amount)
{
object returnvar = Interface.CallHook("CanBeSplashed", this, splashType, amount);
if (returnvar is bool)
{
return (bool)returnvar;
}
if (IsSleeping())
{
return false;
}
// …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.