UE3:UTGame internal variables (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 03:44, 26 July 2008 by Unknown user (talk)
UT3 Object >> Actor >> Info >> GameInfo >> UTGame (internal variables)
UTGame internal variables in other games:
Other member categories for this class:

Internal variables

Acronym

Type: string


Default value: "???"

ActiveBots

Type: array<ActiveBotInfo>

Modifiers: globalconfig


AdjustedDifficulty

Type: float


bAdminModifiedOptions

Type: bool

set when admin modified options via UTPlayerController::ServerAdminChangeOption()

bAllowHoverboard

Type: bool


bAllowKeyboardAndMouse

Type: bool

This being false implies that only gamepads are valid for input type. This is not 100% precise as you could have a keyboard + gamepad which could be valid if we wanted to allow typing but no movement.

bAllowMapVoting

Type: bool

Modifiers: globalconfig

If true, users can vote in order to pick the next map

Default value: True

bAllowTranslocator

Type: bool


bAutoNumBots

Type: bool

Match bots to map's recommended bot count

bBadSinglePlayerBotNames

Type: bool

Debug: used to draw HUD message so it's easy to tell when bots are set up incorrectly in SP missions

bConsoleServer

Type: bool

Prefix characters for names of maps for this game type

bCustomBots

Type: bool


bDemoMode

Type: bool

turn off HUD, etc.

BeaconList

Type: UTProj_TransDisc


bExportMenuData

Type: bool

if set, when this class is compiled, a menu entry for it will be automatically added/updated in its package.ini file (abstract classes are skipped even if this flag is set)

Default value: True

bExtraHealth

Type: bool

Used during the campaign to give player team a health bonuse

bFinalStartup

Type: bool


bFirstBlood

Type: bool


bForceMidGameMenuAtStart

Type: bool

Modifiers: config


bForceRespawn

Type: bool

Modifiers: globalconfig


bHeavyArmor

Type: bool

Used during the campaign to give player team an armor bonus

bIgnoreTeamForVoiceChat

Type: bool

When enabled, allows players on different teams to voice chat with each other. (Used for Duel games) Note that spectators still won't be able to talk to players and vice-versa, though.

bMidGameHasMap

Type: bool


bMidGameMapVoting

Type: bool

Modifiers: globalconfig

If false, users will only be presented with a map list at the end of the round

Default value: True

bMustHaveMultiplePlayers

Type: bool


bMustJoinBeforeStart

Type: bool

players can only spectate if they join after the game starts

bNecrisLocked

Type: bool

Used during the campaign to keep player team from using necris vehicles (until they get the magic key)

bNoCustomCharacters

Type: bool

Modifiers: globalconfig

If true, no custom characters will be allowed, all players will be default

BotClass

Type: class<UTBot>

class used for AI bots

Default value: Class'UTGame.UTBot'

BotRatio

Type: float

Modifiers: globalconfig

only used when bPlayersVsBots is true

Default value: 1.0

bOverTimeBroadcast

Type: bool


bPlayedFiveKills

Type: bool


bPlayedOneKill

Type: bool


bPlayedTenKills

Type: bool

Flag whether "X kills remain" has been played yet

bPlayerBecameActive

Type: bool


bPlayersMustBeReady

Type: bool

Modifiers: globalconfig

players must confirm ready for game to start

bPlayersVsBots

Type: bool


bQuickStart

Type: bool


bScoreDeaths

Type: bool

Whether scoring is based on enemy deaths

bSkipPlaySound

Type: bool

override "play!" sound

bSoaking

Type: bool


bStartedCountDown

Type: bool


bTeamScoreRounds

Type: bool


bTempForceRespawn

Type: bool

Force dead players to respawn immediately if true (configurable)

bUndrivenVehicleDamage

Type: bool

whether not yet driven vehicles can take damage

bWaitForNetPlayers

Type: bool

Modifiers: globalconfig

Temporary (used in game) version of bForceRespawn

Default value: True

bWarmupRound

Type: bool

Modifiers: config

If true, this match will have a warmup round

bWeaponStay

Type: bool

Whether or not weapons stay when picked up.

Default value: True

ClientProcessingTimeout

Type: int

Modifiers: config

how long we wait for clients to perform initial processing at the start of the game (UTPlayerController::bInitialProcessingComplete)

Default value: 30

ConsolePlayerControllerClass

Type: class<PlayerController>

PlayerController class to use on consoles

Default value: Class'UTGame.UTConsolePlayerController'

CountDown

Type: int


Default value: 4

CustomMapPrefixes

Type: array<GameTypePrefix>

Modifiers: globalconfig

Used for loading appropriate game type if non-specified in URL

DefaultEnemyRosterClass

Type: string


DefaultInventory

Type: array<class<Inventory> >

Default inventory added via AddDefaultInventory()

Default value, index 0: Class'UTGame.UTWeap_Enforcer'

Default value, index 1: Class'UTGame.UTWeap_ImpactHammer'

DefaultMapPrefixes

Type: array<GameTypePrefix>


Default value, index 0:

Member Value
AdditionalGameTypes
  1. "UTGame.UTTeamGame"
  2. "UTGame.UTDuelGame"
GameType "UTGame.UTDeathmatch"
Prefix "DM"

Default value, index 1:

Member Value
GameType "UTGameContent.UTCTFGame_Content"
Prefix "CTF"

Default value, index 2:

Member Value
GameType "UTGameContent.UTOnslaughtGame_Content"
Prefix "WAR"

Default value, index 3:

Member Value
GameType "UTGameContent.UTVehicleCTFGame_Content"
Prefix "VCTF"

Default value, index 4:

Member Value
GameType "UTGame.DemoGame"
Prefix "DG"

Default value, index 5:

Member Value
GameType "UTGame.UTMissionSelectionGame"
Prefix "UTM"

Default value, index 6:

Member Value
GameType "UTGame.UTCinematicGame"
Prefix "UTCIN"

DefaultMaxLives

Type: int


DemoPrefix

Type: string

prefix of filename to record a demo to - a number is added on to get a unique filename (empty string means don't record)

Description

Type: string

Modifiers: localized


DesiredPlayerCount

Type: int

bots will fill in to reach this value as needed

EndGameFocus

Type: Actor


EndMessageCounter

Type: int

Modifiers: transient

end message counter

EndMessageWait

Type: int

wait before playing which team won the match

Default value: 1

EndOfMatchRulesTemplateStr_Scoring

Type: string

Modifiers: localized


EndOfMatchRulesTemplateStr_ScoringSingle

Type: string

Modifiers: localized


EndOfMatchRulesTemplateStr_Time

Type: string

Modifiers: localized


EndTime

Type: float


EndTimeDelay

Type: float

Modifiers: globalconfig


Default value: 4.0

EnemyRoster

Type: UTTeamInfo


EnemyRosterName

Type: string


GameSpecificMapCycles

Type: array<GameMapCycle>

Modifiers: globalconfig


Default value, index 0:

Member Value
GameClassName 'UTDeathmatch'
Maps
  1. "DM-Arsenal"
  2. "DM-Biohazard"
  3. "DM-Sanctuary"
  4. "DM-Deck"
  5. "DM-Defiance"
  6. "DM-Deimos"
  7. "DM-Diesel"
  8. "DM-Gateway"
  9. "DM-HeatRay"
  10. "DM-Fearless"
  11. "DM-RisingSun"
  12. "DM-Sentinel"
  13. "DM-ShangriLa"
  14. "DM-Carbonfire"

Default value, index 1:

Member Value
GameClassName 'UTTeamGame'
Maps
  1. "DM-Arsenal"
  2. "DM-Biohazard"
  3. "DM-Sanctuary"
  4. "DM-Deck"
  5. "DM-Defiance"
  6. "DM-Deimos"
  7. "DM-Diesel"
  8. "DM-Gateway"
  9. "DM-HeatRay"
  10. "DM-Fearless"
  11. "DM-RisingSun"
  12. "DM-Sentinel"
  13. "DM-ShangriLa"
  14. "DM-Carbonfire"

Default value, index 2:

Member Value
GameClassName 'UTCTFGame_Content'
Maps
  1. "CTF-CircuitBreaker"
  2. "CTF-Coret"
  3. "CTF-Hydrosis"
  4. "CTF-Reflection"
  5. "CTF-Vertebrae"
  6. "CTF-OmicronDawn"
  7. "CTF-Strident"

Default value, index 3:

Member Value
GameClassName 'UTVehicleCTFGame_Content'
Maps
  1. "VCTF-Kargo"
  2. "VCTF-Suspense"
  3. "VCTF-Corruption"
  4. "VCTF-Containment"
  5. "VCTF-Sandstorm"
  6. "VCTF-Necropolis"

Default value, index 4:

Member Value
GameClassName 'UTOnslaughtGame_Content'
Maps
  1. "WAR-Downtown"
  2. "WAR-SinkHole"
  3. "WAR-Dusk"
  4. "WAR-Islander"
  5. "WAR-Avalanche"
  6. "WAR-MarketDistrict"
  7. "WAR-OnyxCoast"
  8. "WAR-Powersurge"
  9. "WAR-Serenity"
  10. "WAR-FloodGate"
  11. "WAR-Torlan"
  12. "WAR-TankCrossing"

GameUMenuType

Type: string

Type of Game dropdown to display.

InitialVoteDelay

Type: int

Modifiers: globalconfig

The amount of time that must pass before voting is initialized (only applies to midgame voting)

Default value: 30

LastEncouragementTime

Type: float

Last time bot yelled encouragement to player

Default value: -20.0

LastManDownTime

Type: float

Last time bot yelled mandown to player

LastPlayerStartSpot

Type: NavigationPoint

last place current player looking for start spot started from

LastStartSpot

Type: NavigationPoint

last place any player started from

LateEntryLives

Type: int

Modifiers: config

defines how many lives in a player can still join

Default value: 1

MapCycleIndex

Type: int

Modifiers: globalconfig

index of current map in the cycle

MapPrefixes

Type: array<string>

Used for loading appropriate game type if non-specified in URL

MapVotePercentage

Type: int

Modifiers: globalconfig

The percentage of votes needed to secure an immediate map switch

Default value: 51

MidGameMenuTemplate

Type: UTUIScene


Default value: UTUIScene_MidGameMenu'UI_InGameHud.Menus.MidGameMenu'

MidgameScorePanelTag

Type: name


Default value: 'DMPanel'

MinMapVotes

Type: int

Modifiers: globalconfig

The minimum number of votes required to initiate a map switch midgame

Default value: 2

MinNetPlayers

Type: int

Modifiers: globalconfig

how many players must join before net game will start

Default value: 1

NetWait

Type: int

Modifiers: config

time to wait for players in netgames w/ bWaitForNetPlayers (typically team games)

Default value: 15

NumDivertedOpponents

Type: int

for single player when "Tactical Diversion" card is used - skip adding this many Kismet spawned bots

PendingMatchElapsedTime

Type: int


PlayerDeaths

Type: int


PlayerKills

Type: int


RestartWait

Type: int

Modifiers: globalconfig


Default value: 30

RulesMenuType

Type: string

Type of rules menu to display.

ScriptedStartSpot

Type: NavigationPoint

forces the spawn location for the next player spawned

ServerSkillLevel

Type: int

Modifiers: globalconfig

The Server Skill Level ( 0 - 2, Beginner/Experienced/Expert )

SinglePlayerMissionID

Type: int

Used by the single player game

Sniper

Type: Pawn

Current sniper

SpawnProtectionTime

Type: float


Default value: 2.0

SpeechRecognitionData

Type: SpeechRecognition

object containing speech recognition data to use for this gametype

Default value: SpeechRecognition'SpeechRecognition.Alphabet'

StartupStage

Type: byte

what startup message to display

TranslocatorClass

Type: class<Inventory>

class to add to default inventory when translocator is enabled (translocator can't be enabled unless this has a value)

VehicleList

Type: UTVehicle


VictoryMessageClass

Type: class<UTVictoryMessage>


Default value: Class'UTGame.UTVictoryMessage'

VoteCollector

Type: UTVoteCollector

The actual object that manages voting

VoteCollectorClassName

Type: string

Modifiers: globalconfig

Name of the object that manages voting

VoteDuration

Type: int

Modifiers: globalconfig

How long the voting will take MAX (applies only to endgame voting)

Default value: 45

WarmupRemaining

Type: int

How much time left in the Warmup Round

WarmupTime

Type: int

Modifiers: config

How long is the warmup round (In Seconds)

WeaponTauntUsed

Type: byte

Array size: 20

weapon specific Taunt management (keep them from being used multiple times per round)

WebServerClassName

Type: string

Modifiers: globalconfig

Name of the class that supplies the webserver

Default value: "UWeb.WebServer"

WebServerObject

Type: Actor