VRC Override Methods reference.cs

using UdonSharp;
using VRC.SDK3.Components.Video;
using VRC.SDKBase;
using VRC.Udon.Common;

public class OverrideList : UdonSharpBehaviour
{
    //
    // More info
    // https://docs.vrchat.com/docs/event-nodes
    //
    public override void Interact()
    {
        // runs when you Interact with an object
    }

    public override void OnSpawn()
    {
        //Runs when you spawn an object
    }

    /*
     * Overship transfers
     */
    public override void OnOwnershipTransferred(VRCPlayerApi _player)
    {
        //Runs when this object changes owners
        //
        //Extra note:
        //Picking up an object transfers ownership
    }
    public override bool OnOwnershipRequest(VRCPlayerApi _requestingPlayer, VRCPlayerApi _currentOwner)
    {
        //When an object tries to transfer Ownship
        //this will run allowing you to define if ownership is allowed to transfer.
        //
        //If this isnt present in your code it will retruen True by default allowing the owner to change.
        return true;
    }

    /*
     * Pickups
     * These must be attached to an object with VRC_Pickup on it
     */
    public override void OnPickup()
    {
        //Runs for the player that pickups the object
    }
    public override void OnDrop()
    {
        //Runs for the player that drops the object
    }
    public override void OnPickupUseDown()
    {
        //Runs for the player that uses the pickup
    }
    public override void OnPickupUseUp()
    {
        //Runs for the player that stops using the pickup
    }

    /*
     * Player Events
     */
    public override void OnPlayerJoined(VRCPlayerApi _player)
    {
        //Runs when a player joins
        //Returns that player that joined
    }

    public override void OnPlayerLeft(VRCPlayerApi _player)
    {
        //runs when a player leaves
        //Returns that player that left
    }
    public override void OnPlayerRespawn(VRCPlayerApi player)
    {
        //Runs when a player respawns
        //this may run for EVERYONE when somone respawns
        //will be tested and updated at a later date
    }
    public override void OnPlayerParticleCollision(VRCPlayerApi player)
    {
        //This has to be added to a Particle System to run

        //When a Particle with collision from the Particle System hits a player, this runs.
        //This only triggers for the local player that gets hit due to player particle collision being local only.
    }
    public override void OnPlayerTriggerEnter(VRCPlayerApi player)
    {
        //This has to be attached to a GameObject with a trigger collider on it
        //if a player has multiple colliders on their avatar, this will run once for each collider they have.

        //Runs whan any player enters a Trigger.
        //If a client doesnt have the trigger enabled, it will not run.
    }
    public override void OnPlayerTriggerExit(VRCPlayerApi player)
    {
        //This has to be attached to a GameObject with a trigger collider on it
        //if a player has multiple colliders on their avatar, this will run once for each collider they have.

        //Runs whan any player Exits a Trigger.
        //If a client doesnt have the Trigger enabled, it will not run.
        //This will still call if the Trigger gets turned off when the client is inside of it.
    }
    public override void OnPlayerTriggerStay(VRCPlayerApi player)
    {
        //This has to be attached to a GameObject with a trigger collider on it
        //if a player has multiple colliders on their avatar, this will run once for each collider they have.

        //Runs on every frame whan a player is inside of a Trigger.
    }

    public override void OnPlayerCollisionEnter(VRCPlayerApi player)
    {
        //This has to be attached to a GameObject with a collider on it
        //if a player has multiple colliders on their avatar, this will run once for each collider they have.

        //Runs whan any player enters a Collider.
        //If a client doesnt have the Collider enabled, it will not run.
    }
    public override void OnPlayerCollisionExit(VRCPlayerApi player)
    {
        //This has to be attached to a GameObject with a collider on it
        //if a player has multiple colliders on their avatar, this will run once for each collider they have.

        //Runs whan any player Exits a Collider.
        //If a client doesnt have the Collider enabled, it will not run.
        //This will still call if the Collider gets turned off when the client is inside of it.
    }
    public override void OnPlayerCollisionStay(VRCPlayerApi player)
    {
        //This has to be attached to a GameObject with a collider on it
        //if a player has multiple colliders on their avatar, this will run once for each collider they have.

        //Runs on every frame whan a player is inside of a Trigger.
    }
    public override void PostLateUpdate()
    {
        //runs every frane after the IK is calculated
    }

    /*
     * Stations
     * These are what chairs use to work
     */
    public override void OnStationEntered(VRCPlayerApi _player)
    {
        //Runs when you enter a chair
    }
    public override void OnStationExited(VRCPlayerApi _player)
    {
        //Runs when you leave a chair
    }

    /*
     * Video Player
     * 
     * These need to be on an VideoPlayer component to work
     */
    public override void OnVideoEnd()
    {
        //When a video ends
    }
    public override void OnVideoPause()
    {
        //When a video pauses
    }
    public override void OnVideoPlay()
    {
        //When a video starts playing, this can include:
        //Video first starts
        //UnPausing a video
    }
    public override void OnVideoStart()
    {
        //Runs when a video player starts from a stopped state.
        //seems to be the same as OnVideoPlay()
    }
    public override void OnVideoLoop()
    {
        //Runs when a video loops
    }
    public override void OnVideoReady()
    {
        //Runs when a video loads in and is ready to be played, but not when the video plays.
    }
    public override void OnVideoError(VideoError videoError)
    {
        //Requires "using VRC.SDK3.Components.Video;" to be used
    }
    /*
     * Serialization
     */
    public override void OnDeserialization()
    {
        //This runs whenever the client recives Networking data.
    }
    public override void OnPreSerialization()
    {
        //This runs before the client sends Networking data.
    }
    public override void OnPostSerialization(SerializationResult result)
    {
        //requires "using VRC.Udon.Common;" to use

        //From what i understand this
        //runs after all other Serialization event and allows you top check if it was sent successfully.
    }

    /*
     * MIDI
     */
    public override void MidiControlChange(int channel, int number, int value)
    {
        //Runs when a Control changes on the MIDI controller. this basically anything that isnt a note
        //Examples beiong a slider, a knob, or a sustain pedal
    }
    public override void MidiNoteOn(int channel, int number, int velocity)
    {
        //Runs when you push a MIDI note
    }
    public override void MidiNoteOff(int channel, int number, int velocity)
    {
        //Runs when you let go of a MIDI note
    }
}