LocalEventHandler Class

Summary

This class provides auto subscription to the local event manager events and provides functions handling local events.
Namespace
ASL.LocalEventSystem
Base Types
  • Photon.PunBehaviour
Derived Types
graph TD Base0["Photon.PunBehaviour"]-->Type Type["LocalEventHandler"] class Type type-node Type-->Derived0["PortalInstantiator"] click Derived0 "/2019.CRCS-WebSite/Documentation/api/ASL.PortalSystem/PortalInstantiator" Type-->Derived1["BillboardText"] click Derived1 "/2019.CRCS-WebSite/Documentation/api/ASL.PlayerSystem/BillboardText" Type-->Derived2["VRInitilizationScript"] click Derived2 "/2019.CRCS-WebSite/Documentation/api/ASL.VirtualReality/VRInitilizationScript" Type-->Derived3["ControllerInstantiation"] click Derived3 "/2019.CRCS-WebSite/Documentation/api/ASL.PlayerSystem/ControllerInstantiation"

Syntax

public abstract class LocalEventHandler : Photon.PunBehaviour

Methods

Name Value Summary
OnDestroy() void
Unsubscribes from the lcal events system to prevent a memory leak.
OnEnable() void
Subscribes to Local event system, when a local event is trigger the OnLocalEvent function will be called.
OnJoinedRoom() void
Callback function that is triggered when this user connects and joins a Photon room. Useful for making instantiation calls through Photon.
OnLocalEvent(object, ASLLocalEventManager.LocalEventArgs) void
Function to be implemented by derived classes. Should operate with a switch statement using the appropriate LocalEvents values from the Enum in ASLLocalEventManager.
OnPhotonInstantiate(PhotonMessageInfo) void
Callback function that is triggered when an object is created via photon.