NetworkManager Class Reference

Manages network-related operations on the client side, including connection handling, user synchronization, transform and animation updates, and messaging. It is part of EDA architecture of the library. More...

Inheritance diagram for NetworkManager:

Public Member Functions
void	ConnectToServer ()
	Initiates a connection to the server.
void	DisconnectFromServer ()
	Sends a request to disconnect the client from the server.
void	AddUser (GameObject userPrefab)
	Adds a newly spawned user object to the list of online users.
GameObject	GetUserByName (string username)
	Retrieves a user GameObject by username.
GameObject	GetUserById (int id)
	Retrieves a user GameObject by user ID.
void	SpawnUser (int id, string userName, bool isLocal)
	Instantiates and initializes a new user object in the scene.
void	DisconnectForeignUser (int id)
	Removes a remote user object from the scene based on its ID.
void	SendTextMessage (string message, int mode, int id)
	Sends a text message to either all users or a specific user.
void	sendTestMessage ()
	Sends a test broadcast message to the server.
void	UpdateTransform (Transform objectTransform)
	Sends the updated transform of the local user to the server.
void	SendAnimatorParameter (int type, string name, float value)
	Sends an animation parameter change to the server for synchronization.

Public Attributes
List< GameObject >	onlineUsers
	List of all currently active (connected) user GameObjects in the scene.
Transform[]	spawnPoints
	Predefined spawn points used for placing newly connected users in the scene.

Static Public Attributes
static NetworkManager	networkManager
	Singleton instance of the NetworkManager.

Private Member Functions
void	Awake ()
	Initializes the singleton instance of the NetworkManager.
void	Start ()
	Subscribes to client events for handling network state changes and data reception, can be easily extended of new events.
void	HandleConnected ()
	Callback invoked when the client successfully connects to the server.
void	HandleConnectionFailed (string reason)
	Callback invoked when the connection to the server fails.
void	HandleMessage (string message)
	Callback for processing a received message from the server.
void	HandleDisconnected ()
	Callback invoked when the client is disconnected from the server. Removes all user objects from the scene.
void	HandleTransformChange (int id, Vector3 pos, Quaternion rot)
	Applies a received position and rotation update to the corresponding remote user.
void	HandleAnimationChange (int id, int type, string name, float value)
	Applies a received animation parameter change to the corresponding remote user.

Private Attributes
ClientSettings	ClientSettings
	Configuration settings for the client, including user prefab and other preferences.

Detailed Description

Manages network-related operations on the client side, including connection handling, user synchronization, transform and animation updates, and messaging. It is part of EDA architecture of the library.

Definition at line 10 of file NetworkManager.cs.

Member Function Documentation

AddUser()

void NetworkManager.AddUser

(

GameObject

userPrefab

)

Adds a newly spawned user object to the list of online users.

Definition at line 142 of file NetworkManager.cs.

    {
        onlineUsers.Add(userPrefab);
    }

Awake()

void NetworkManager.Awake ( )

private

Initializes the singleton instance of the NetworkManager.

Definition at line 32 of file NetworkManager.cs.

    {
        if (networkManager == null)
        {
            networkManager = this;
        }
        else if (networkManager != this)
        {
            Destroy(this);
        }
    }

ConnectToServer()

void NetworkManager.ConnectToServer

(

)

Initiates a connection to the server.

Definition at line 58 of file NetworkManager.cs.

    {
        Client.instance.ConnectToServer();
    }

DisconnectForeignUser()

void NetworkManager.DisconnectForeignUser

(

int

id

)

Removes a remote user object from the scene based on its ID.

Definition at line 186 of file NetworkManager.cs.

    {
        foreach (GameObject user in onlineUsers)
        {
            if (user.GetComponent<NetworkUser>().GetId() == id)
            {
                GameObject UserObject = user;
                onlineUsers.Remove(user);
                Destroy(UserObject);
                break;
            }
        }
    }

DisconnectFromServer()

void NetworkManager.DisconnectFromServer

(

)

Sends a request to disconnect the client from the server.

Definition at line 65 of file NetworkManager.cs.

    {
        Client.instance.DisconnectRequested();
    }

GetUserById()

GameObject NetworkManager.GetUserById

(

int

id

)

Retrieves a user GameObject by user ID.

Definition at line 163 of file NetworkManager.cs.

    {
        foreach (GameObject user in onlineUsers)
        {
            if (user.GetComponent<NetworkUser>().GetId() == id)
            {
                return user;
            }
        }
        return null;
    }

GetUserByName()

GameObject NetworkManager.GetUserByName

(

string

username

)

Retrieves a user GameObject by username.

Definition at line 149 of file NetworkManager.cs.

    {
        foreach (GameObject user in onlineUsers)
        {
            if (user.GetComponent<NetworkUser>().GetUsername() == username)
            {
                return user;
            }
        }
        return null;
    }

HandleAnimationChange()

void NetworkManager.HandleAnimationChange ( int id, int type, string name, float value )

private

Applies a received animation parameter change to the corresponding remote user.

Definition at line 125 of file NetworkManager.cs.

    {
        foreach (GameObject userObject in onlineUsers)
        {
            if (userObject.GetComponent<NetworkUser>().GetId() == id)
            {
                NetworkAnimator nt = userObject.GetComponent<NetworkAnimator>();
                if (nt != null && !nt.UserInfo.isLocalUser)
                {
                    nt.ApplyRemoteParameter(type, name, value);
                }
            }
        }
    }

HandleConnected()

void NetworkManager.HandleConnected ( )

private

Callback invoked when the client successfully connects to the server.

Definition at line 72 of file NetworkManager.cs.

    {
        //
    }

HandleConnectionFailed()

void NetworkManager.HandleConnectionFailed ( string reason )

private

Callback invoked when the connection to the server fails.

Definition at line 79 of file NetworkManager.cs.

    {
        Debug.LogError("NETWORKMANAGER: Connection failed: " + reason);
        // 
    }

HandleDisconnected()

void NetworkManager.HandleDisconnected ( )

private

Callback invoked when the client is disconnected from the server. Removes all user objects from the scene.

Definition at line 95 of file NetworkManager.cs.

    {
        Debug.Log("NETWORKMANAGER: Disconnected from server.");
        foreach (GameObject user in onlineUsers)
        {
            GameObject UserObject = user;
            onlineUsers.Remove(user);
            Destroy(UserObject);
        }
    }

HandleMessage()

void NetworkManager.HandleMessage ( string message )

private

Callback for processing a received message from the server.

Definition at line 87 of file NetworkManager.cs.

    {
        // 
    }

HandleTransformChange()

void NetworkManager.HandleTransformChange ( int id, Vector3 pos, Quaternion rot )

private

Applies a received position and rotation update to the corresponding remote user.

Definition at line 108 of file NetworkManager.cs.

    {
        foreach(GameObject userObject in onlineUsers)
        {
            if(userObject.GetComponent<NetworkUser>().GetId() == id)
            {
                NetworkTransform nt = userObject.GetComponent<NetworkTransform>();
                if (nt != null && !nt.UserInfo.isLocalUser)
                {
                    nt.ApplyNetworkTransform(pos, rot);
                }
            }
        }
    }

SendAnimatorParameter()

void NetworkManager.SendAnimatorParameter	(	int	type,
		string	name,
		float	value )

Sends an animation parameter change to the server for synchronization.

Definition at line 228 of file NetworkManager.cs.

    {
        Client.instance.AnimationUpdate(type,name,value);
    }

sendTestMessage()

void NetworkManager.sendTestMessage

(

)

Sends a test broadcast message to the server.

Definition at line 214 of file NetworkManager.cs.

    {
        SendTextMessage("Test message", 1, 0);
    }

SendTextMessage()

void NetworkManager.SendTextMessage	(	string	message,
		int	mode,
		int	id )

Sends a text message to either all users or a specific user.

Definition at line 202 of file NetworkManager.cs.

    {
        if(mode == 1) { 
            Client.instance.MessageToAllRequest(message);
        } else
        {
            Client.instance.MessageToUserRequest(message, id);
        }
    }

SpawnUser()

void NetworkManager.SpawnUser	(	int	id,
		string	userName,
		bool	isLocal )

Instantiates and initializes a new user object in the scene.

Definition at line 177 of file NetworkManager.cs.

    {
        GameObject UserPrefab = Instantiate(ClientSettings.userPrefab[0], spawnPoints[0]);
        UserPrefab.GetComponent<NetworkUser>().SetUser(id, userName, isLocal);
        networkManager.AddUser(UserPrefab);
    }

Start()

void NetworkManager.Start ( )

private

Subscribes to client events for handling network state changes and data reception, can be easily extended of new events.

Definition at line 46 of file NetworkManager.cs.

    {
        Client.instance.OnConnected += HandleConnected;
        Client.instance.OnConnectionFailed += HandleConnectionFailed;
        Client.instance.OnDisconnected += HandleDisconnected;
        Client.instance.OnMessageReceived += HandleMessage;
        Client.instance.OnTransformReceived += HandleTransformChange;
        Client.instance.OnAnimationChangeReceived += HandleAnimationChange;
    }

UpdateTransform()

void NetworkManager.UpdateTransform

(

Transform

objectTransform

)

Sends the updated transform of the local user to the server.

Definition at line 221 of file NetworkManager.cs.

    {
        Client.instance.UpdateTransform(objectTransform);
    }

Member Data Documentation

ClientSettings

ClientSettings NetworkManager.ClientSettings

private

Configuration settings for the client, including user prefab and other preferences.

Definition at line 23 of file NetworkManager.cs.

networkManager

NetworkManager NetworkManager.networkManager

static

Singleton instance of the NetworkManager.

Definition at line 15 of file NetworkManager.cs.

onlineUsers

List<GameObject> NetworkManager.onlineUsers

List of all currently active (connected) user GameObjects in the scene.

Definition at line 19 of file NetworkManager.cs.

spawnPoints

Transform [] NetworkManager.spawnPoints

Predefined spawn points used for placing newly connected users in the scene.

Definition at line 27 of file NetworkManager.cs.