Skip to main content

Events

Unity events​

Use the usual Unity method names. They run on every player's copy of the script.

EventWhen
Start()Once, after the world has loaded and the Inspector values are applied
Update() / LateUpdate()Every frame
FixedUpdate()Every physics step
OnEnable() / OnDisable()The GameObject or script was enabled / disabled
OnTriggerEnter(Collider) / OnTriggerExit(Collider)A collider entered or left this object's trigger

StageTime events​

Override these (public override void ...).

EventWhenRuns on
Interact()The local player clicked this object (it needs a collider)the clicking player
OnDeserialization()New [Synced] values arrivedeveryone except the owner
OnPlayerJoined(StageTimePlayer)A player joined. When you join, it also runs once for every player already thereeveryone
OnPlayerLeft(StageTimePlayer)A player lefteveryone
OnOwnershipTransferred(StageTimePlayer)This object's owner changedeveryone
OnPickup() / OnDrop()The local player picked up / dropped this object's ST Pickupthe holder
OnPickupUseDown() / OnPickupUseUp()The holder pressed / released the trigger (VR) or use button (desktop)the holder
OnSeatEntered(StageTimePlayer) / OnSeatExited(..)A player sat in / left this object's ST Seateveryone
OnPlayerTriggerEnter(StageTimePlayer) / OnPlayerTriggerExit(..)A player walked into / out of this object's trigger collidereveryone
OnVideoStart(), OnVideoPlay(), OnVideoPause()This object's ST Video Player started a new video, resumed, pausedeveryone
OnVideoEnd(), OnVideoError()This object's ST Video Player finished, or failed to load or playeach device
public override void OnPlayerJoined(StageTimePlayer player)
{
Debug.Log($"{player.displayName} joined ({StageTimePlayer.GetPlayerCount()} players)");
}

public override void OnPlayerTriggerEnter(StageTimePlayer player)
{
if (player.isLocal) player.TeleportTo(target.position, target.rotation);
}