ExampleUI
Parameter Definitions
Select the parameter name from below to jump directly to it on this page.
AvailableRooms
AvailableScenes
ChooseRoomPage
HostGamePage
JoinGamePage
LoadingBar
LoadingDescriptionText
LoadingPage
LoadingPreviewImage
LoadingPreviewImageTransitionSpeed
LoadingTitleText
LobbyPage
MainPage
NameErrorPage
NameInputField
NetworkErrorPage
NetworkErrorText
PanelPage
PlayerCardAnimation
PlayerCardPage
PlayerCardText
PlayerNamePage
PlayerPrefabSelectPage
RoomNameInput
connectionStatus
createRoomButton
effectChildren
fadeInAudio
fadeInUI
fadeObjects
fadeOutSpeed
finalClick
finalClickVolume
loadImageDisplayTime
lobbyIndex
lobbyOnlyRoomCreate
mouseClick
mouseClickVolume
mouseEnter
mouseEnterVolume
mouseExit
mouseExitVolume
musicSource
playerCardDisplayTime
players
roomButton
soundSource
startVolume
successNameInputTravelTo
titleImage
uiFadeSpeed
AvailableRooms
The transform element in your UI that will be used as a parent object for your room button.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
AvailableScenes
The transform element in your UI that will be used as a parent object for your available scenes buttons. This is a child element of your "ChooseRoomPage\
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
ChooseRoomPage
The page that is displayed when there is more than one available room to join.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
HostGamePage
The gameobject that holds all the child elements that make up the host game page.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
JoinGamePage
The gameobject that holds all the child elements that make up the join game page.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
LoadingBar
The loading bar to display when loading a page.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Slider | None |
LoadingDescriptionText
The loading page description text to display.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Text | None |
LoadingPage
The page to display when loading a scene.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
LoadingPreviewImage
The loading page preview image to display.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Image | None |
LoadingPreviewImageTransitionSpeed
How fast to fade in and out the images on the loading page.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.5f |
LoadingTitleText
The loading page title text to display.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Text | None |
LobbyPage
The page to display when you are connected to a lobby of a room (NOT A PHOTON LOBBY).
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
MainPage
The gameobject that holds all the child elements that make up the main page.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
NameErrorPage
The gameobject to enable when the player attempts to input an invalid name.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
NameInputField
The input field element that will be used to set the player name.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | InputField | None |
NetworkErrorPage
The gameobject to enable when you wish to display a network error.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
NetworkErrorText
The text element that will be used to display any network errors/events.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Text | None |
PanelPage
The gameobject that holds everything, just in case you need to disable everything.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
PlayerCardAnimation
The animation component to call to player slide in/out animations.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Animation | None |
PlayerCardPage
The gameobject to display a player card.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
PlayerCardText
The text to set to display the recently joined player.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Text | None |
PlayerNamePage
The gameobject that holds all the child elements to set a players name.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
PlayerPrefabSelectPage
The gameobject that holds all the child elements to allow a player to select their character(prefab).
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
RoomNameInput
The input field element that will be used to capture the room name to start.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | InputField | None |
connectionStatus
String elements that will be populated by the network manager connection status.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | Text[] | None |
createRoomButton
The gameobject that holds the "Create Room" button.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
effectChildren
When fading do you want to effect the parent object and all of its children?
| Exposed Value | Type | Default Value |
|---|---|---|
| private | bool | true |
fadeInAudio
When first loading the UI, fade in the audio.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | bool | false |
fadeInUI
Fade in your UI when first loading it.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | bool | true |
fadeObjects
When fading effect this object. If effect all children is selected it will effect this object and all of its children.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | GameObject[] | null |
fadeOutSpeed
If fading out your music how to fast to fade out. Higher values will fade out faster.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.25f |
finalClick
The sound that will be played when you call the "PlayerFinalClick" function.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | AudioClip | null |
finalClickVolume
How loud to play the "finalClick" sound.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.5f |
loadImageDisplayTime
How long to display the loading images on the loading page before begining the fade/out in process.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 5.0f |
lobbyIndex
The index of the scene that will act as your room’s lobby. You can find this index in the Build Settings when you specify what scenes to build in your project.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | int | 0 |
lobbyOnlyRoomCreate
You must be in the lobby for the "Create Room" button to be displayed.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | bool | true |
mouseClick
The sound that will be played when you call the "PlayerMouseClick" function.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | AudioClip | null |
mouseClickVolume
How loud to play the "mouseClick" sound.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.5f |
mouseEnter
The sound that will be played when you call the "PlayerMouseEnter" function.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | AudioClip | null |
mouseEnterVolume
How loud to play the "mouseEnter" sound.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.5f |
mouseExit
The sound that will be played when you call the "PlayerMouseExit" function.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | AudioClip | null |
mouseExitVolume
How loud to play the "mouseExit" sound.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.5f |
musicSource
The audio source that will play your menu music.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | AudioSource | None |
playerCardDisplayTime
How long to show the player card before sliding out.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 10.0f |
players
All of the possible players that can be selected. Used in combination with “
the "SelectPlayer" function in this component. Call this function BEFORE attempting “
to spawn your player as the playerPrefab on the NetworkManager is set from this “
function.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject[] | null |
roomButton
A prefab element that will be spawned in when a room is found from the server.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
soundSource
The audio source that will play your menu sounds.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | AudioSource | None |
startVolume
How loud to set your audio to.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 0.5f |
successNameInputTravelTo
The gameobject to set active after successfully entering your player name. “
If not supplied will travel to PlayerPrefabPage
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | null |
titleImage
The gameobject that is the title image.
| Exposed Value | Type | Default Value |
|---|---|---|
| public | GameObject | None |
uiFadeSpeed
How fast to fade in your UI. Higher values will fade in faster.
| Exposed Value | Type | Default Value |
|---|---|---|
| private | float | 1.0f |