Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTDom.DomPlayerController


00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
/**
 * Used to save the players preffered team for use with the TeamPicker (UIDomPlayerConfigScene)
 * 
 * Writen by Brian 'Snake' Alexander. Copyright(c) 2010 All Rights Reserved.
 */
class DomPlayerController extends UTMT_PlayerController
   config(Dom);
`include(UTDom.uci)

var config byte SavedTeamID;
var config bool bHasSavedTeam;

/**
 * returns the players bHasSavedTeam value
 */
reliable client function bool HasSavedTeam()
{
   return bHasSavedTeam;
}

/**
 * validates the input for a value between 0-3
 * otherwise default to 0
 * 
 * @param   MyTeamID    The value to validate
 * @param   MaxTeams    The number of teams in the current game
 */
static function byte IsValidDOMTeamID(byte MyTeamID, byte MaxTeams)
{
   if (MyTeamID > MaxTeams)
      return 0;

   return MyTeamID;
}

/**
 * Returns a valid SavedTeamID value
 * 
 * @param   MaxTeamID    The highest TeamID in the current game.Expecting a number between 1 and 3.
 */
reliable client function byte GetSavedTeamID(byte MaxTeamID)
{
   local byte T, M;
   
   M = Clamp(MaxTeamID-1, 1, 3);
   T = Clamp(SavedTeamID, 0, M);
   return T;
}

/**
 * Saves a valid SavedTeamID value
 * 
 * @param   NewSavedTeamID    The highest TeamID in the current game.Expecting a number between 1 and 3.
 */
reliable client function SetSavedTeamID(byte NewSavedTeamID)
{
   SavedTeamID = Clamp(NewSavedTeamID, 0, 3);
   SaveConfig();
}

defaultproperties
{
   SavedTeamID=0
`if(`isdefined(PLATFORM_PS3))
   bHasSavedTeam=False
`else
   bHasSavedTeam=True
`endif
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Class file time: Wed 8/12/2010 21:18:00.000 - Creation time: Fri 23/12/2011 20:31:26.338 - Created with UnCodeX