Engine/source/T3D/aiConnection.cpp

   1 //-----------------------------------------------------------------------------
   2 // Copyright (c) 2012 GarageGames, LLC
   3 //
   4 // Permission is hereby granted, free of charge, to any person obtaining a copy
   5 // of this software and associated documentation files (the "Software"), to
   6 // deal in the Software without restriction, including without limitation the
   7 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   8 // sell copies of the Software, and to permit persons to whom the Software is
   9 // furnished to do so, subject to the following conditions:
  10 //
  11 // The above copyright notice and this permission notice shall be included in
  12 // all copies or substantial portions of the Software.
  13 //
  14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20 // IN THE SOFTWARE.
  21 //-----------------------------------------------------------------------------
  22
  23 #include "T3D/aiConnection.h"
  24 #include "console/engineAPI.h"
  25
  26 IMPLEMENT_CONOBJECT( AIConnection );
  27
  28 ConsoleDocClass( AIConnection,
  29    "@brief Special client connection driven by an AI, rather than a human.\n\n"
  30
  31    "Unlike other net connections, AIConnection is intended to run unmanned. Rather than "
  32    "gathering input from a human using a device, move events, triggers, and look events "
  33    "are driven through functions like AIConnection::setMove.\n\n"
  34
  35    "In addition to having its own set of functions for managing client move events, "
  36    "a member variable inherited by GameConnection is toggle: mAIControlled. This is useful "
  37    "for a server to determine if a connection is AI driven via the function GameConnection::isAIControlled\n\n"
  38
  39    "AIConnection is an alternative to manually creating an AI driven game object. When you "
  40    "want the server to manage AI, you will create a specific one from script using a "
  41    "class like AIPlayer. If you do not want the server managing the AI and wish to simulate "
  42    "a complete client connection, you will use AIConnection\n\n."
  43
  44    "To get more specific, if you want a strong alternative to AIPlayer (and wish to make use "
  45    "of the AIConnection structure), consider AIClient. AIClient inherits from AIConnection, "
  46    "contains quite a bit of functionality you will find in AIPlayer, and has its own Player "
  47    "object.\n\n"
  48
  49    "@tsexample\n"
  50    "// Create a new AI client connection\n"
  51    "%botConnection = aiConnect(\"MasterBlaster\" @ %i, -1, 0.5, false, \"SDF\", 1.0);\n\n"
  52    "// In another area of the code, you can locate this and any other AIConnections\n"
  53    "// using the isAIControlled function\n"
  54    "for(%i = 0; %i < ClientGroup.getCount(); %i++)\n"
  55    "{\n"
  56    "   %client = ClientGroup.getObject(%i);\n"
  57    "   if(%client.isAIControlled())\n"
  58    "   {\n"
  59    "      // React to this AI controlled client\n"
  60    "   }\n"
  61    "}\n"
  62    "@endtsexample\n\n"
  63
  64    "@note This is a legacy class, which you are discouraged from using as it will "
  65    "most likely be deprecated in a future version. For now it has been left in for "
  66    "backwards compatibility with TGE and the old RTS Kit. Use GameConnection "
  67    "and AIPlayer instead.\n\n"
  68
  69    "@see GameConnection, NetConnection, AIClient\n\n"
  70
  71    "@ingroup AI\n"
  72    "@ingroup Networking\n"
  73 );
  74 //-----------------------------------------------------------------------------
  75
  76 AIConnection::AIConnection() {
  77    mAIControlled = true;
  78    mMove = NullMove;
  79 }
  80
  81
  82 //-----------------------------------------------------------------------------
  83
  84 void AIConnection::clearMoves( U32 )
  85 {
  86    // Clear the pending move list. This connection generates moves
  87    // on the fly, so there are never any pending moves.
  88 }
  89
  90 void AIConnection::setMove(Move* m)
  91 {
  92    mMove = *m;
  93 }
  94
  95 const Move& AIConnection::getMove()
  96 {
  97    return mMove;
  98 }
  99
 100 /// Retrive the pending moves
 101 /**
 102  * The GameConnection base class queues moves for delivery to the
 103  * controll object.  This function is normally used to retrieve the
 104  * queued moves recieved from the client.  The AI connection does not
 105  * have a connected client and simply generates moves on-the-fly
 106  * base on it's current state.
 107  */
 108 U32 AIConnection::getMoveList( Move **lngMove, U32 *numMoves )
 109 {
 110    *numMoves = 1;
 111    *lngMove = &mMove;
 112    return *numMoves;
 113 }
 114
 115
 116 //-----------------------------------------------------------------------------
 117 // Console functions & methods
 118 //-----------------------------------------------------------------------------
 119
 120 //-----------------------------------------------------------------------------
 121
 122 static inline F32 moveClamp(F32 v)
 123 {
 124    // Support function to convert/clamp the input into a move rotation
 125    // which only allows 0 -> M_2PI.
 126    F32 a = mClampF(v, -M_2PI_F, M_2PI_F);
 127    return (a < 0) ? a + M_2PI_F : a;
 128 }
 129
 130
 131 //-----------------------------------------------------------------------------
 132 /// Construct and connect an AI connection object
 133 ConsoleFunction(aiConnect, S32 , 2, 20, "(...)"
 134    "@brief Creates a new AIConnection, and passes arguments to its onConnect script callback.\n\n"
 135    "@returns The newly created AIConnection\n"
 136    "@see GameConnection for parameter information\n"
 137    "@ingroup AI")
 138 {
 139    // Create the connection
 140    AIConnection *aiConnection = new AIConnection();
 141    aiConnection->registerObject();
 142
 143    // Add the connection to the client group
 144    SimGroup *g = Sim::getClientGroup();
 145    g->addObject( aiConnection );
 146
 147    // Prep the arguments for the console exec...
 148    // Make sure and leav args[1] empty.
 149    const char* args[21];
 150    args[0] = "onConnect";
 151    args[1] = NULL; // Filled in later
 152    for (S32 i = 1; i < argc; i++)
 153       args[i + 1] = argv[i];
 154
 155    // Execute the connect console function, this is the same
 156    // onConnect function invoked for normal client connections
 157    Con::execute(aiConnection, argc + 1, args);
 158    return aiConnection->getId();
 159 }
 160
 161
 162 //-----------------------------------------------------------------------------
 163 DefineConsoleMethod(AIConnection, setMove, void, (const char * field, F32 value), ,"(string field, float value)"
 164               "Set a field on the current move.\n\n"
 165               "@param   field One of {'x','y','z','yaw','pitch','roll'}\n"
 166               "@param   value Value to set field to.")
 167 {
 168    Move move = object->getMove();
 169
 170    // Ok, a little slow for now, but this is just an example..
 171    if (!dStricmp(field,"x"))
 172       move.x = mClampF(value,-1,1);
 173       else
 174    if (!dStricmp(field,"y"))
 175       move.y = mClampF(value,-1,1);
 176       else
 177    if (!dStricmp(field,"z"))
 178       move.z = mClampF(value,-1,1);
 179       else
 180    if (!dStricmp(field,"yaw"))
 181       move.yaw = moveClamp(value);
 182       else
 183    if (!dStricmp(field,"pitch"))
 184       move.pitch = moveClamp(value);
 185       else
 186    if (!dStricmp(field,"roll"))
 187       move.roll = moveClamp(value);
 188
 189    //
 190    object->setMove(&move);
 191 }
 192
 193 DefineConsoleMethod(AIConnection,getMove,F32, (const char * field), ,"(string field)"
 194               "Get the given field of a move.\n\n"
 195               "@param field One of {'x','y','z','yaw','pitch','roll'}\n"
 196               "@returns The requested field on the current move.")
 197 {
 198    const Move& move = object->getMove();
 199    if (!dStricmp(field,"x"))
 200       return move.x;
 201    if (!dStricmp(field,"y"))
 202       return move.y;
 203    if (!dStricmp(field,"z"))
 204       return move.z;
 205    if (!dStricmp(field,"yaw"))
 206       return move.yaw;
 207    if (!dStricmp(field,"pitch"))
 208       return move.pitch;
 209    if (!dStricmp(field,"roll"))
 210       return move.roll;
 211    return 0;
 212 }
 213
 214
 215 DefineConsoleMethod(AIConnection,setFreeLook,void,(bool isFreeLook), ,"(bool isFreeLook)"
 216               "Enable/disable freelook on the current move.")
 217 {
 218    Move move = object->getMove();
 219    move.freeLook = isFreeLook;
 220    object->setMove(&move);
 221 }
 222
 223 DefineConsoleMethod(AIConnection, getFreeLook, bool, (), ,"getFreeLook()"
 224               "Is freelook on for the current move?")
 225 {
 226    return object->getMove().freeLook;
 227 }
 228
 229
 230 //-----------------------------------------------------------------------------
 231
 232 DefineConsoleMethod(AIConnection,setTrigger,void, (S32 idx, bool set), ,"(int trigger, bool set)"
 233               "Set a trigger.")
 234 {
 235    if (idx >= 0 && idx < MaxTriggerKeys)
 236    {
 237       Move move = object->getMove();
 238       move.trigger[idx] = set;
 239       object->setMove(&move);
 240    }
 241 }
 242
 243 DefineConsoleMethod(AIConnection,getTrigger,bool, (S32 idx), ,"(int trigger)"
 244               "Is the given trigger set?")
 245 {
 246    if (idx >= 0 && idx < MaxTriggerKeys)
 247       return object->getMove().trigger[idx];
 248    return false;
 249 }
 250
 251
 252 //-----------------------------------------------------------------------------
 253
 254 DefineConsoleMethod(AIConnection,getAddress,const char*,(), ,"")
 255 {
 256    // Override the netConnection method to return to indicate
 257    // this is an ai connection.
 258    return "ai:local";
 259 }