GameConnection

Public Functions

activateGhosting()

Called by the server during phase 2 of the mission download to start sending ghosts to the client.

Ghosts represent objects on the server that are in scope for the client. These need to be synchronized with the client in order for the client to see and interact with them. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence.

function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB)
{
   // Make sure to ignore calls from a previous mission load
   if (%seq != $missionSequence || !$MissionRunning)
      return;
   if (%client.currentPhase != 1.5)
      return;
   %client.currentPhase = 2;

   // Set the player datablock choice
   %client.playerDB = %playerDB;

   // Update mod paths, this needs to get there before the objects.
   %client.transmitPaths();

   // Start ghosting objects to the client
   %client.activateGhosting();
}

chaseCam(int size)

Sets the size of the chase camera's matrix queue.

note:

This sets the queue size across all GameConnections.

note:

This is not currently hooked up.

clearCameraObject()

Clear the connection's camera object reference.

clearDisplayDevice()

Clear any display device.

A display device may define a number of properties that are used during rendering.

clearPreSelectedObj()

clearSelectedObj(bool propagate_to_client)

delete(string reason)

On the server, disconnect a client and pass along an optional reason why.

This method performs two operations: it disconnects a client connection from the server, and it deletes the connection object. The optional reason is sent in the disconnect packet and is often displayed to the user so they know why they've been disconnected.

Parameters:

function kick(%client)
{
   messageAll( 'MsgAdminForce', '\c2The Admin has kicked %1.', %client.playerName);

   if (!%client.isAIControlled())
      BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime);
   %client.delete("You have been kicked from this server");
}

getCameraObject()

Returns the connection's camera object used when not viewing through the control object.

getControlCameraDefaultFov()

Returns the default field of view as used by the control object's camera.

getControlCameraFov()

Returns the field of view as used by the control object's camera.

getControlObject()

On the server, returns the object that the client is controlling.By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game.

getControlSchemeAbsoluteRotation()

Get the connection's control scheme absolute rotation property.

getDamageFlash()

On the client, get the control object's damage flash level.

getSelectedObj()

getVisibleGhostDistance()

Gets the distance that objects around the connection will be ghosted.

getWhiteOut()

On the client, get the control object's white-out level.

isAIControlled()

Returns true if this connection is AI controlled.

isControlObjectRotDampedCamera()

Returns true if the object being controlled by the client is making use of a rotation damped camera.

isDemoPlaying()

Returns true if a previously recorded demo file is now playing.

isDemoRecording()

Returns true if a demo file is now being recorded.

isFirstPerson()

Returns true if this connection is in first person mode.

note:

Transition to first person occurs over time via mCameraPos, so this won't immediately return true after a set.

listClassIDs()

List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems.

note:

The list is sent to the console.

loadDatablockCache()

loadDatablockCache_Begin()

loadDatablockCache_Continue()

play2D(SFXProfile profile)

Used on the server to play a 2D sound that is not attached to any object.

Parameters:

function ServerPlay2D(%profile)
{
   // Play the given sound profile on every client.
   // The sounds will be transmitted as an event, not attached to any object.
   for(%idx = 0; %idx < ClientGroup.getCount(); %idx++)
      ClientGroup.getObject(%idx).play2D(%profile);
}

play3D(SFXProfile profile, TransformF location)

Used on the server to play a 3D sound that is not attached to any object.

Parameters:

function ServerPlay3D(%profile,%transform)
{
   // Play the given sound profile at the given position on every client
   // The sound will be transmitted as an event, not attached to any object.
   for(%idx = 0; %idx < ClientGroup.getCount(); %idx++)
      ClientGroup.getObject(%idx).play3D(%profile,%transform);
}

playDemo(string demoFileName)

On the client, play back a previously recorded game session.

It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection.

resetGhosting()

On the server, resets the connection to indicate that ghosting has been disabled.

Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that ghosts are no longer being transmitted. On the client end, all ghost information will be deleted.

// Inform the clients
for (%clientIndex = 0; %clientIndex < ClientGroup.getCount(); %clientIndex++)
{
   // clear ghosts and paths from all clients
   %cl = ClientGroup.getObject(%clientIndex);
   %cl.endMission();
   %cl.resetGhosting();
   %cl.clearPaths();
}

saveDatablockCache()

setBlackOut(bool doFade, int timeMS)

On the server, sets the client's 3D display to fade to black.

Parameters:

note:

Not currently hooked up, and is not synchronized over the network.

setCameraObject(GameBase camera)

On the server, set the connection's camera object used when not viewing through the control object.

setConnectArgs(const char * args)

On the client, pass along a variable set of parameters to the server.

Once the connection is established with the server, the server calls its onConnect() method with the client's passed in parameters as aruments.

setControlCameraFov(float newFOV)

On the server, sets the control object's camera's field of view.

Parameters:

note:

When transmitted over the network to the client, the resolution is limited to one degree. Any fraction is dropped.

setControlObject(GameBase ctrlObj)

On the server, sets the object that the client will control.

By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game.

Parameters:

setControlSchemeParameters(bool absoluteRotation, bool addYawToAbsRot, bool addPitchToAbsRot)

Set the control scheme that may be used by a connection's control object.

Parameters:

setFirstPerson(bool firstPerson)

On the server, sets this connection into or out of first person mode.

Parameters:

setJoinPassword(string password)

On the client, set the password that will be passed to the server.

On the server, this password is compared with what is stored in $pref::Server::Password. If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, if the passed in client password and the server password do not match, the CHR_PASSWORD error string is sent back to the client and the connection is immediately terminated.

This password checking is performed quite early on in the connection request process so as to minimize the impact of multiple failed attempts – also known as hacking.

setMissionCRC(int CRC)

On the server, transmits the mission file's CRC value to the client.

Typically, during the standard mission start phase 1, the mission file's CRC value on the server is send to the client. This allows the client to determine if the mission has changed since the last time it downloaded this mission and act appropriately, such as rebuilt cached lightmaps.

Parameters:

function serverCmdMissionStartPhase1Ack(%client, %seq)
{
   // Make sure to ignore calls from a previous mission load
   if (%seq != $missionSequence || !$MissionRunning)
      return;
   if (%client.currentPhase != 0)
      return;
   %client.currentPhase = 1;

   // Start with the CRC
   %client.setMissionCRC( $missionCRC );

   // Send over the datablocks...
   // OnDataBlocksDone will get called when have confirmation
   // that they've all been received.
   %client.transmitDataBlocks($missionSequence);
}

setPreSelectedObjFromRollover()

setSelectedObj(SceneObject obj, bool propagate_to_client)

setSelectedObjFromPreSelected()

setVisibleGhostDistance(float dist)

Sets the distance that objects around it will be ghosted. If set to 0, it may be defined by the LevelInfo.

@dist - is the max distance

startRecording(string fileName)

On the client, starts recording the network connection's traffic to a demo file.

It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection.

Parameters:

stopRecording()

On the client, stops the recording of a connection's network traffic to a file.

transmitDataBlocks(int sequence)

Sent by the server during phase 1 of the mission download to send the datablocks to the client.

SimDataBlocks, also known as just datablocks, need to be transmitted to the client prior to the client entering the game world. These represent the static data that most objects in the world reference. This is typically done during the standard mission start phase 1 when following Torque's example mission startup sequence.

When the datablocks have all been transmitted, onDataBlocksDone() is called to move the mission start process to the next phase.Parameters:

function serverCmdMissionStartPhase1Ack(%client, %seq)
{
   // Make sure to ignore calls from a previous mission load
   if (%seq != $missionSequence || !$MissionRunning)
      return;
   if (%client.currentPhase != 0)
      return;
   %client.currentPhase = 1;

   // Start with the CRC
   %client.setMissionCRC( $missionCRC );

   // Send over the datablocks...
   // OnDataBlocksDone will get called when have confirmation
   // that they've all been received.
   %client.transmitDataBlocks($missionSequence);
}

getServerConnection()