SceneTransition
Jump To Parameters
Jump To Function Definitions
Parameter Definitions
Select the parameter name from below to jump directly to it on this page.
BeforeTravel
LoadSceneName
OnAnyPlayerEnterTrigger
OnAnyPlayerExitTrigger
OnOwnerEnterTrigger
OnOwnerExitTrigger
SpawnAtPoint
activeOnEnter
autoTravel
buttonToTravel
database
sendAllTogether
BeforeTravel
UnityEvent, travel has been called, but this event fires right before.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | UnityEvent | null |
LoadSceneName
The name of the scene to load. This must be an exact spelling according to what is in the build settings.
| Exposed Value | Type | Default Value |
|---|---|---|
| protected | string | ”” |
OnAnyPlayerEnterTrigger
UnityEvent, called when ANY player enter the trigger, owner or networked player
| Exposed Value | Type | Default Value |
|---|---|---|
| private | UnityEvent | null |
OnAnyPlayerExitTrigger
UnityEvent, called when ANY player exits the trigger, owner or networked player
| Exposed Value | Type | Default Value |
|---|---|---|
| private | UnityEvent | null |
OnOwnerEnterTrigger
UnityEvent that is called when the owner enters this trigger, not a networked player.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | UnityEvent | null |
OnOwnerExitTrigger
UnityEvent that is called when the owner exits this trigger, not the networked player.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | UnityEvent | null |
SpawnAtPoint
The name of the LoadPoint object to spawn at in the desired scene. This naming must be exact.
| Exposed Value | Type | Default Value |
|---|---|---|
| protected | string | ”” |
activeOnEnter
The gameobjects to active/deactive when entering/exiting this trigger.
| Exposed Value | Type | Default Value |
|---|---|---|
| protected | GameObject[] | null |
autoTravel
When entring this trigger whether or not to automatically move to the new scene or not.
| Exposed Value | Type | Default Value |
|---|---|---|
| protected | bool | false |
buttonToTravel
The button that must be pressed when inside this trigger to travel the new scene.
| Exposed Value | Type | Default Value |
|---|---|---|
| protected | string | “E” |
database
The scene database that holds a list of all scenes and LoadPoint objects in those scenes.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | SceneDatabase | None |
sendAllTogether
Whether to send everyone when traveling or to just send the person entering.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | bool | true |
Function Definitions
Select the function name from below to jump directly to it on this page.
OnTriggerEnter
OnTriggerExit
SetDatabase
Travel
Update
protected virtual void OnTriggerEnter(Collider other)
Will do actions only when a vThirdPersonController enters the trigger and nothing else.
| Expose Value | Overrideable | Returns |
|---|---|---|
| protected | True | Does not return anything |
| Parameter Name | Description |
|---|---|
| other | Collider type, only vThirdPersonController players fire this |
protected virtual void OnTriggerExit(Collider other)
Will do actions only when a vThirdPersonController leaves the trigger and nothing else.
| Expose Value | Overrideable | Returns |
|---|---|---|
| protected | True | Does not return anything |
| Parameter Name | Description |
|---|---|
| other | Collider type, only vThirdPersonController players fire this |
public virtual void SetDatabase(SceneDatabase input)
Used for automation. Sets the
databasevariable with the input sceneDatabase.
| Expose Value | Overrideable | Returns |
|---|---|---|
| public | True | Does not return anything |
| Parameter Name | Description |
|---|---|
| input | SceneDatabase type, the sceneDatabase to have this component reference |
public virtual void Travel()
Calls
SendToSceneRPC for everyone or yourself based on thesendAllTogethervariable. Finds the scene to load from thedatabaseand callsNetworkLoadLevelfrom the NetworkManager component.
| Expose Value | Overrideable | Returns |
|---|---|---|
| public | True | Does not return anything |
No parameters
protected virtual void Update()
If a owning vThirdPersonController is in the trigger and presses the
buttonToTravelit will call theTravelfunction.
| Expose Value | Overrideable | Returns |
|---|---|---|
| protected | True | Does not return anything |
No parameters