Back To Index

UICoreLogic

Jump To Parameters
Jump To Function Definitions

Parameter Definitions

Select the parameter name from below to jump directly to it on this page.

OnCompleteLevelLoading
OnCountdownStarted
OnCountdownStopped
OnCreateRoomFailed
OnCreateRoomSuccess
OnNameEnterFailed
OnNameEnterSuccess
OnNetworkError
OnReceiveRoundTime
OnReconnecting
OnResetEverything
OnSceneLoaded
OnStart
OnStartLoading
OnStartSession
OnWaitToJoinPhotonRoomsLobby
debugging
defaultLevelIndex
fadeInAudio
fadeInSpeed
finalClick
finalClickVolume
loadingBar
loadingDesc
loadingDescText
loadingImageDisplayTime
loadingImages
loadingPageFadeSpeed
loadingParent
loadingTitle
loadingTitleText
mainLoadingImage
mouseClick
mouseClickVolume
mouseEnter
mouseEnterVolume
mouseExit
mouseExitVolume
musicSource
sceneList
selectablePlayers
soundSource
startVolume
teamsUpdated
voiceViewUpdated

OnCompleteLevelLoading

UnityEvent. Called when you have completely loaded a unity scene.

Back To Top

OnCountdownStarted

UnityEvent. Called when you receive a start countdown PhotonEvent.

Back To Top

OnCountdownStopped

UnityEvent. Called when you receive a stop countdown PhotonEvent.

Back To Top

OnCreateRoomFailed

UnityEvent. Called when creating a photon room fails.

Back To Top

OnCreateRoomSuccess

UnityEvent. Called when creating a photon room succeeds.

Back To Top

OnNameEnterFailed

UnityEvent. Called when entering a name for your player fails.

Back To Top

OnNameEnterSuccess

UnityEvent. Called when entering a name for your player succeeds.

Back To Top

OnNetworkError

UnityEvent. Called when you receive a network error.

Back To Top

OnReceiveRoundTime

UnityEvent. Called when you receive an update round time PhotonEvent.

Back To Top

OnReconnecting

UnityEvent. Called when you were disconnected from the photon server and”
are now attempting to reconnect to the last room you were in.

Back To Top

OnResetEverything

UnityEvent. Called when you want to reset the UI back to it’s default state.

Back To Top

OnSceneLoaded

UnityEvent. Called everytime when a unity scene is first loaded.

Back To Top

OnStart

UnityEvent. Called only once in the OnStart method of this component.

Back To Top

OnStartLoading

UnityEvent. Called when you have just started loading a unity scene.

Back To Top

OnStartSession

Called when you successfully create a new session.

Back To Top

OnWaitToJoinPhotonRoomsLobby

UnityEvent. Called right after you attempt to join the photon lobby.

Back To Top

debugging

Log everything that happens to the unity console.

Back To Top

defaultLevelIndex

If you don’t set the scene to load this is the default level index it will use.

Back To Top

fadeInAudio

When first loading the UI, fade in the audio.

Back To Top

fadeInSpeed

If fading out your music how to fast to fade out. Higher values will fade out faster.

Back To Top

finalClick

The sound that will be played when you call the "PlayerFinalClick" function.

Back To Top

finalClickVolume

How loud to play the "finalClick" sound.

Back To Top

loadingBar

The loading bar.

Back To Top

loadingDesc

The description text that will be set when the loading screen is displayed.

Back To Top

loadingDescText

The text object that will be used to display your loading description text.

Back To Top

loadingImageDisplayTime

How long to display each image before fading to the next one.

Back To Top

loadingImages

The image that will display when loading the screen.

Back To Top

loadingPageFadeSpeed

How fast to fade the images in and out.

Back To Top

loadingParent

The Parent Object that holds all of the loading page transforms.

Back To Top

loadingTitle

The title text that will be set when the loading screen is displayed

Back To Top

loadingTitleText

The text object that will be used to display your loading title text.

Back To Top

mainLoadingImage

The image that will be displaying your main loading sprite

Back To Top

mouseClick

The sound that will be played when you call the "PlayerMouseClick" function.

Back To Top

mouseClickVolume

How loud to play the "mouseClick" sound.

Back To Top

mouseEnter

The sound that will be played when you call the "PlayerMouseEnter" function.

Back To Top

mouseEnterVolume

How loud to play the "mouseEnter" sound.

Back To Top

mouseExit

The sound that will be played when you call the "PlayerMouseExit" function.

Back To Top

mouseExitVolume

How loud to play the "mouseExit" sound.

Back To Top

musicSource

The audio source that will play your menu music.

Back To Top

sceneList

A list of SceneOptions to choose from when you want to implement “
a way for players to select the scene they would like to join.

Back To Top

selectablePlayers

The complete list of players that are selectable to the end user.

Back To Top

soundSource

The audio source that will play your menu sounds.

Back To Top

startVolume

How loud to set your audio to.

Back To Top

teamsUpdated

Delegate. Called when any player on a team is added or removed.

Back To Top

voiceViewUpdated

Delegate. Called when the voice view is updated.

Back To Top

Function Definitions

Select the function name from below to jump directly to it on this page.

AddNewPlayerToPlayerReadyList
AddToTeamData
AllPlayersReady
ClearPlayerReadyDict
ClearPlayerUIs
ClearSavedRoomPassword
ClearSceneVoteList
ClearTeamData
CreatePrivateSession
CreateRandomSceneList
CreateSessionWithSavedRoomName
Disconnect
EnableChatBoxVisibility
EnableChatboxSlideOut
EnableLoadingPage
EnableMouseMovement
EnableMouseVisibility
EnableMusic
EnablePlayerAutoSpawn
EnableRoomNameChecking
EnableSavedPlayerUI
EveryoneLoadLevel
EveryoneLoadLevel
EveryoneLoadSavedLevel
FadeMusic
GetMyTeamName
GetPlayerVoiceView
GetRandomSceneNumber
GetSavedSceneToLoadName
GetSceneNumber
GetSceneVotes
GetSetPlayer
GetSetPlayerIndex
GetUserTeamName
JoinLobby
JoinPrivateRoom
JoinRandomPublicRoomOrCreateOne
JoinRoom
JoinSavedRoomName
KickPlayer
LoadSavedLevel
LoopMusic
MouseSelect
MouseSelectHandle
MouseSelectTarget
NetworkErrorOccured
PhotonEvent_AUTOSPAWN
PhotonEvent_KICKPLAYER
PhotonEvent_MAPCHANGE
PhotonEvent_RANDOMSCENELIST
PhotonEvent_READUP
PhotonEvent_ROUNDTIME
PhotonEvent_SCENEVOTE
PhotonEvent_STARTCOUNTDOWN
PhotonEvent_STARTSESSION
PhotonEvent_TEAMCHANGE
PhotonEvent_VOICEVIEW
PlayFinalClick
PlayMouseClick
PlayMouseEnter
PlayMouseExit
PlayMusic
PlayerInReadyDict
PlayerIsReady
QuitGame
RecievedPhotonEvent
ReconnectingToLastRoom
RefreshPlayerUIs
RemovePlayerToPlayerReadyList
ResetEverything
ResetLoadingBar
RestartMusic
SavePlayerName
SavePlayerUIs
SaveRoomList
SaveRoomName
SaveRoomPassword
SaveSceneToLoad
SaveSceneToLoad
SceneLoaded
SendCreatedRandomSceneList
SendEnableAutoSpawn
SendReadyState
SendRoundTime
SendSceneChangeInfo
SendSceneVote
SendStartCountdown
SendStartSession
SendStopCountdown
SendUpdateVoiceView
SetFadeToVolume
SetMusicAudio
SetMusicVolume
SetMyTeamName
SetPlayer
SetRandomSceneList
SetRoomIsJoinable
SetRoomVisibility
Start
StopMusic
SubmitSavedPlayerName
Update
VisualKickPlayer
WaitForRandomJoin

public virtual void AddNewPlayerToPlayerReadyList(Photon.Realtime.Player player)

Takes a Photon.Realtime.Player input and extracts the user id of that player and adds it to the player ready dictionary as not ready. If that player’s user id already exists in the dictionary it will make it be marked as not ready.

Back To Top

public virtual void AddToTeamData(string userId, string teamName)

Returns the entire team data dictionary. This dictionary is a list of users ids and the teams those ids are on. Adds the user id to the team name. If that user id is already in the dictionary it will move that user id to the new team name.

Back To Top

public virtual bool AllPlayersReady()

Checks all the user ids in the player ready dictionary and sees if they have been marked as ready or not.

No parameters

Back To Top

public virtual void ClearPlayerReadyDict()

Erases the entire dictionary of what players are ready.

No parameters

Back To Top

public virtual void ClearPlayerUIs()

Remove all saved player UIs from local manipulation.

No parameters

Back To Top

public virtual void ClearSavedRoomPassword()

Clears the _roomPassword internal variable.

No parameters

Back To Top

public virtual void ClearSceneVoteList()

Clears the _sceneVotes dictionary so it no longer has ANY votes in it.

No parameters

Back To Top

public virtual void ClearTeamData()

Erases the entire team data dictionary.

No parameters

Back To Top

public virtual void CreatePrivateSession()

Attempts to create a photon room with the saved _roomName and _roomPassword variables. Calls the OnCreateRoomFailed or OnCreateRoomSuccess UnityEvents if the room creation was successfull or not.

No parameters

Back To Top

public virtual void CreateRandomSceneList()

Populates the _randomSceneList list. This is used for players to cast votes as to what scene they would like to play at.

No parameters

Back To Top

public virtual void CreateSessionWithSavedRoomName(bool useSavedPassword = false)

Create the initial photon room that will become the session name for your session. If you want to create a password protected room pass in true. Also will perform checks on the room name to make sure it’s valid if you have enabled the _roomNameChecking variable to be true. Calls the NetworkManager’s CreateRoom function to create the Photon room. Finally calls OnCreateRoomSuccess UnityEvent if the room creation was successfull, or calls OnCreateRoomFailed if it was not.

Back To Top

public virtual void Disconnect()

Calls the NetworkManager’s Disconnect function to disconnect from the photon room.

No parameters

Back To Top

public virtual void EnableChatBoxVisibility(bool isEnabled)

Make the chatbox inactive or not. True = Can see chatbox, False = Can NOT see chatbox

Back To Top

public virtual void EnableChatboxSlideOut(bool isEnabled)

Make the chatbox slide in or out. True = Slide out(visible), False = Slide in(not visible)

Back To Top

public virtual void EnableLoadingPage(bool isEnabled)

Display the loading page UI or not.

Back To Top

public virtual void EnableMouseMovement(bool isEnabled)

Allow the mouse to be moved around or not.

Back To Top

public virtual void EnableMouseVisibility(bool isVisible)

Hide or show the mouse.

Back To Top

public virtual void EnableMusic(bool isEnabled)

Disables/Enables the musicSource component based on the input value.

Back To Top

public virtual void EnablePlayerAutoSpawn(bool setActive)

Sets the NetworkManager’s autoSpawnPlayer value to whatever input value you use.

Back To Top

public virtual void EnableRoomNameChecking(bool isEnabled)

Returns the internal variable _rooms. This is just a list of potential photon rooms. Turn on valid room name checking. This makes it so rooms names can’t have invalid characters or be blank. If this is on and rooms have these it will throw an error.

Back To Top

public virtual void EnableSavedPlayerUI(bool isEnabled)

Find all of the UI’s that invector provides and enable them or not.

Back To Top

public virtual void EveryoneLoadLevel(string levelName)

Calls the NetworkManager’s NetworkLoadLevel with the sendEveryone value as true. It will load the unity scene based on the input value’s index.

Back To Top

public virtual void EveryoneLoadLevel(int levelIndex)

Calls the NetworkManager’s NetworkLoadLevel with the sendEveryone` value as true. It will load the unity scene based on the index you pass in.

Back To Top

public virtual void EveryoneLoadSavedLevel()

Calls the NetworkManager’s NetworkLoadLevel function with the sendEveryone variable as true. It uses the previously saved level name’s index.

No parameters

Back To Top

public virtual void FadeMusic(bool fadeOut)

Fade the musicSource in or out based on the input value. True = Fade Out, False = Fade In

Back To Top

public virtual string GetMyTeamName()

Returns the string value that is stored in the NetworkManager’s teamName parameter.

No parameters

Back To Top

public virtual int GetPlayerVoiceView(string UserId)

Get the voice view of the passed in photon user id.

Back To Top

public virtual SceneOption GetRandomSceneNumber(int value)

Returns an amount of random SceneOption’s from the _randomSceneList list.

Back To Top

public virtual string GetSavedSceneToLoadName()

Returns the previously saved level name

No parameters

Back To Top

public virtual SceneOption GetSceneNumber(int value)

Extracts the SceneOption value from the sceneList list at the specified index.

Back To Top

public virtual int GetSceneVotes(int sceneIndex)

Returns the entire _sceneVotes dictionary which contains all the votes that people have currently cast for a scene index.

Back To Top

public virtual GameObject GetSetPlayer()

Get the playerPrefab from the network manager.

No parameters

Back To Top

public virtual int GetSetPlayerIndex()

Returns the current selected player index that will be used to select a player later.

No parameters

Back To Top

public virtual string GetUserTeamName(string userId)

Finds the team name that the photon user id is a part of.

Back To Top

public virtual void JoinLobby()

Calls the instanced NetworkManager’s JoinLobby function.

No parameters

Back To Top

public virtual void JoinPrivateRoom()

Calls the instance’d NetworkManager’s JoinRandomRoom function with the previous set internal variables _roomName and _roomPassword parameters.

No parameters

Back To Top

public virtual void JoinRandomPublicRoomOrCreateOne()

Calls the WaitForRandomJoin IEnumerator.

No parameters

Back To Top

public virtual void JoinRoom(string roomname)

Calls the instanceds NetworkManager’s JoinRoom function with the input value and immediately calls the OnWaitToJoinPhotonRoomsLobby UnityEvent.

Back To Top

public virtual void JoinSavedRoomName(bool useSavedPassword)

Calls the instance’d NetworkManager’s JoinRandomRoom function with the _roomName internal variable that was saved from the SaveRoomName function. Also uses the saved _roomPassword is the input value is true. Immediately calls the OnWaitToJoinPhotonRoomsLobby UnityEvent.

Back To Top

public virtual void KickPlayer(string userId)

Calls the VisualKickPlayer IEnumerator wit the userId.

Back To Top

public virtual void LoadSavedLevel()

Calls the NetworkManager’s NetworkLoadLevel function with the previously saved level name’s index.

No parameters

Back To Top

public virtual void LoopMusic(bool setLooping)

Set the musicSource loop value.

Back To Top

public virtual void MouseSelect(GameObject target)

Calls the MouseSelectHandle IEnumerator

Back To Top

IEnumerator MouseSelectHandle(GameObject target)

Sets the target the mouse will select based on the input target.

Back To Top

protected virtual void MouseSelectTarget(GameObject target)

Have the mouse select the target gameobect

Back To Top

public virtual void NetworkErrorOccured(string errorMessage)

Calls the OnNetworkError UnityEvent with the passed in string

Back To Top

protected virtual void PhotonEvent_AUTOSPAWN(object[] data)

Calls the SendEnableAutoSpawn function. This is a received Photon Event.

Back To Top

protected virtual void PhotonEvent_KICKPLAYER(object[] data)

Makes the receiver of this event leave the photon room with an error message. This is a received photon event.

Back To Top

protected virtual void PhotonEvent_MAPCHANGE(object[] data)

Makes the receiver change the saved leve name and index. This is a received photon event.

Back To Top

protected virtual void PhotonEvent_RANDOMSCENELIST(object[] data)

Makes the receiver set their _randomSceneList variable to whatever is received. This is a received photon event.

Back To Top

protected virtual void PhotonEvent_READUP(object[] data)

Makes the user id ready up. This is a received PhotonEvent message.

Back To Top

protected virtual void PhotonEvent_ROUNDTIME(object[] data)

Sets the round time to be whatever is received. This is a received photon event. This also calls the OnReceiveRoundTime UnityEvent.

Back To Top

protected virtual void PhotonEvent_SCENEVOTE(object[] data)

Adds or removes a vote to the scene vote index. This is a received photon event.

Back To Top

protected virtual void PhotonEvent_STARTCOUNTDOWN(object[] data)

Makes the receiver call the OnCountdownStarted or OnCountdownStopped UnityEvents based on the received value. This is a received photon event.

Back To Top

protected virtual void PhotonEvent_STARTSESSION(object[] data)

Makes everyone start the session and this will make it so the RecievedPhotonEvent function will not be called anymore when receiving events from the network.

Back To Top

protected virtual void PhotonEvent_TEAMCHANGE(object[] data)

Makes a user id change to a new team. This is a received PhotonEvent message. Also executes the teamsUpdated delegate.

Back To Top

protected virtual void PhotonEvent_VOICEVIEW(object[] data)

Sets the voice view id for the user id for later referencing. Also calls the voiceViewUpdated delegate. This is a received photon event.

Back To Top

public virtual void PlayFinalClick()

Play the finalClick audio clip from the soundSource

No parameters

Back To Top

public virtual void PlayMouseClick()

Play the mouseClick audio clip from the soundSource

No parameters

Back To Top

public virtual void PlayMouseEnter()

Play the mouseEnter audio clip from the soundSource

No parameters

Back To Top

public virtual void PlayMouseExit()

Play the mouseExit audio clip from the soundSource

No parameters

Back To Top

public virtual void PlayMusic()

Starts playing the audio clip on the musicSource.

No parameters

Back To Top

public virtual bool PlayerInReadyDict(string userId)

Returns true if the user id is already in the player read dictionary.

Back To Top

public virtual bool PlayerIsReady(string userId)

Returns the dictionary of users ids and if they’re ready or not Checks to see if that user id is marked as ready by looking it up in the player ready dictionary.

Back To Top

public virtual void QuitGame()

Quit the unity application.

No parameters

Back To Top

protected virtual void RecievedPhotonEvent(EventData obj)

Called when ANY photon event is received. Will find out what type of event it is and call that function. (EX: If receiving CB_EVENT_STARTSESSION photon event it will call the PhotonEvent_STARTSESSION function)

Back To Top

public virtual void ReconnectingToLastRoom()

Callback method. This is called whenever you’re attempting to reconnect to a photon room.

No parameters

Back To Top

public virtual void RefreshPlayerUIs()

Rebuilds the saved player UIs list.

No parameters

Back To Top

public virtual void RemovePlayerToPlayerReadyList(Photon.Realtime.Player player)

Takes a Photon.Realtime.Player input and extracts the user id of that player, finds that user id in the player ready dictionary and removes it from the dictionary.

Back To Top

public virtual void ResetEverything()

Called when you want to reset the UI back to its default state. Will clear all parameters and attempt to reset this component back to its starting values. Also calls OnResetEverything UnityEvent for additional user-defined actions.

No parameters

Back To Top

public virtual void ResetLoadingBar()

Sets the loadingBar to zero.

No parameters

Back To Top

public virtual void RestartMusic()

Will start the audio clip from the beginning again on the musicSource.

No parameters

Back To Top

public virtual void SavePlayerName(string playerName)

Saves the input string as a future player name that will be used by the \ SubmitSavedPlayerName function.

Back To Top

public virtual void SavePlayerUIs()

Find all the objects tagged with PlayerUI and save them for later manipulation.

No parameters

Back To Top

public virtual void SaveRoomList()

Populates the internal variable _rooms based on the cachedRoomList value in the NetworkManager component.

No parameters

Back To Top

public virtual void SaveRoomName(string roomName)

Stores the room name input for future use into the _roomName internal variable.

Back To Top

public virtual void SaveRoomPassword(string password)

Saves the input string into the _roomPassword internal variable for later use.

Back To Top

public virtual void SaveSceneToLoad(string levelName)

Calls SendSceneChangeInfo function with the extracted index of the scene name that you input and the scene name.

Back To Top

public virtual void SaveSceneToLoad(int levelIndex)

Calls SendSceneChangeInfo with the extracts name of the scene index that you input and the index.

Back To Top

protected virtual void SceneLoaded(Scene scene, LoadSceneMode mode)

Callback method. This is called when a new Unity scene is loaded. This calls the OnSceneLoaded UnityEvent.

Back To Top

public virtual void SendCreatedRandomSceneList()

Calls the CB_EVENT_RANDOMSCENELIST PhotonEvent which will make everyone set their _randomSceneList list to the value that you currently have set in your own _randomSceneList list.

No parameters

Back To Top

public virtual void SendEnableAutoSpawn(bool enableSpawn)

Calls the CB_EVENT_AUTOSPAWN Photon Event. This will make it so autospawn is enabled when a new Unity scene is loaded.

Back To Top

public virtual void SendReadyState(bool isReady)

Calls the CB_EVENT_READYUP PhotonEvent. This event will make your user id be marked as ready or not based on the input value.

Back To Top

public virtual void SendRoundTime(float roundTime)

Calls the CB_EVENT_ROUNDTIME PhotonEvent to set the round time to whatever number is passed into this function for everyone in the photon room.

Back To Top

protected virtual void SendSceneChangeInfo(string sceneName, int index)

Calls the CB_EVENT_MAPCHANGE photon event. Sets the scene name and index for all players in the photon room.

Back To Top

public virtual void SendSceneVote(int sceneIndex)

Calls the CB_EVENT_SCENEVOTE PhotonEvent which will add one to all players _sceneVotes at the index key you have specified.

Back To Top

public virtual void SendStartCountdown(float amount)

Calls the CB_EVENT_STARTCOUNTDOWN PhotonEvent, which will trigger the countdown to start. This will trigger the OnCountdownStarted UnityEvent for all players that receive this event, including yourself.

Back To Top

public virtual void SendStartSession()

Calls the CB_EVENT_STARTSESSION photon event. Which makes everyone start the photon session. Only the master client can call this method.

No parameters

Back To Top

public virtual void SendStopCountdown()

Calls the CB_EVENT_STARTCOUNTDOWN PhotonEvent which will make all players, including yourself, stop the countdown process. This all triggers the OnCountdownStopped UnityEvent for everyone, including yourself.

No parameters

Back To Top

public virtual void SendUpdateVoiceView(string UserId, int ViewId)

Calls the CB_EVENT_VOICEVIEW PhotonEvent. This eventually will execute the voiceViewUpdated delegate.

Back To Top

public virtual void SetFadeToVolume(float fadeToVolume)

Set the music to fade to the selected volume next time you trigger a fade music.

Back To Top

public virtual void SetMusicAudio(AudioClip clip)

Set the musicSource audio clip.

Back To Top

public virtual void SetMusicVolume(float volume)

Immediately set the musicSource volume level.

Back To Top

public virtual void SetMyTeamName(string teamName = “”)

Calls the CB_EVENT_TEAMCHANGE PhotonEvent. This will set your photon user id to be on the team name that matches the input value.

Back To Top

public virtual void SetPlayer(int index)

Will set the player according to the input index. Will choose the player to set as the playerPrefab in the NetworkManager from the selectablePlayers list.

Back To Top

public virtual void SetRandomSceneList(List randomRoomList)

Receives as scene list and sets it to the _randomSceneList list.

Back To Top

public virtual void SetRoomIsJoinable(bool isJoinable)

Calls the NetworkManager’s SetRoomIsOpen function with whatever value you have specified in this function.

Back To Top

public virtual void SetRoomVisibility(bool isVisible)

Make this photon room visible or not. Calls the NetworkManager’s SetRoomVisibility function with the input value specified here.

Back To Top

protected virtual void Start()

Sets the music volume, Adds the AddNewPlayerToPlayerReadyList and RemovePlayerToPlayerReadyList functions to the OnPlayerJoinedCurrentRoom and OnPlayerLeftCurrentRoom delegates of the NetworkManager component. Also sets up the SceneLoaded function to be called when a new scene is loaded.

No parameters

Back To Top

public virtual void StopMusic()

Stops playing the audio clip on the musicSource

No parameters

Back To Top

public virtual void SubmitSavedPlayerName()

Calls the OnNameEnterFailed or OnNameEnterSuccess UnityEvents if the player name that was saved previously passes the tests or not. If it passes the tests it will send this player name to the NetworkManager’s SetPlayerName function.

No parameters

Back To Top

protected virtual void Update()

Controls music volumes, loading bars, load images, loading titles, and loading descriptions.

No parameters

Back To Top

IEnumerator VisualKickPlayer(string userId)

Calls the CB_EVENT_KICKPLAYER PhotonEvent. Which will force the owner of photon user id to leave the photon room.

Back To Top

IEnumerator WaitForRandomJoin()

Joins the Photon Lobby and attempts to find an open room that isn’t at capacity yet. If one isn’t found it will generate a new room with a random hash room name.

No parameters

Back To Top