Always snap to grid

Difference between revisions of "UE2:Invasion (UT2004)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(WaveInfo - amendments to document purpose of Waves variables.)
(WaveInfo - corrected minor formatting issues for clarification)
 
Line 645: Line 645:
 
<!-- enter struct description -->
 
<!-- enter struct description -->
 
; [[int]] WaveMask : bit fields for which monsters appear in this wave. See {{tl|MonsterClass}}.
 
; [[int]] WaveMask : bit fields for which monsters appear in this wave. See {{tl|MonsterClass}}.
; [[byte]] WaveMaxMonsters : Used to set NewMaxMonsters, the upper limit of monsters for that round. Zero-based, so setting to 1 means "no monsters", 2 = only one monster, etc. Also influenced by NumPlayers, NumBots and GameDifficulty.
+
; [[byte]] WaveMaxMonsters : Used to set ''NewMaxMonsters'', the upper limit of monsters for that round. Zero-based, so setting to 1 means "no monsters", 2 = only one monster, etc. Also influenced by ''NumPlayers'', ''NumBots'' and ''GameDifficulty''.
 
; [[byte]] WaveDuration : duration in minutes to complete this wave
 
; [[byte]] WaveDuration : duration in minutes to complete this wave
; [[float]] WaveDifficulty : multiplier adjusting difficulty. Final AdjustedDifficulty is original GameDifficulty plus WaveDifficulty * WaveNum
+
; [[float]] WaveDifficulty : multiplier adjusting difficulty. Final ''AdjustedDifficulty'' is original ''GameDifficulty'' plus ''WaveDifficulty'' for that wave.
  
 
==Functions==
 
==Functions==

Latest revision as of 11:35, 6 February 2016

UT2004 Object >> Actor >> Info >> GameInfo >> UnrealMPGameInfo >> DeathMatch >> TeamGame >> xTeamGame >> Invasion
Package: 
SkaarjPack
This class in other games:
UT2003

null

Constants[edit]

INVPROPNUM[edit]

Value: 8


Properties[edit]

Property group 'Invasion'[edit]

Waves[edit]

Type: WaveInfo

Array size: 16

Modifiers: config

TODO Add support for structs & arrays to PlayInfo

Default value, index 0:

Member Value
WaveDifficulty 0.0
WaveDuration 90
WaveMask 20491
WaveMaxMonsters 16

Default value, index 1:

Member Value
WaveDifficulty 0.0
WaveDuration 90
WaveMask 60
WaveMaxMonsters 12

Default value, index 10:

Member Value
WaveDifficulty 1.5
WaveDuration 180
WaveMask 14340
WaveMaxMonsters 12

Default value, index 11:

Member Value
WaveDifficulty 1.5
WaveDuration 180
WaveMask 4021
WaveMaxMonsters 12

Default value, index 12:

Member Value
WaveDifficulty 1.5
WaveDuration 180
WaveMask 3729
WaveMaxMonsters 12

Default value, index 13:

Member Value
WaveDifficulty 2.0
WaveDuration 180
WaveMask 3972
WaveMaxMonsters 12

Default value, index 14:

Member Value
WaveDifficulty 2.0
WaveDuration 180
WaveMask 3712
WaveMaxMonsters 12

Default value, index 15:

Member Value
WaveDifficulty 2.0
WaveDuration 255
WaveMask 2048
WaveMaxMonsters 8

Default value, index 16:

Member Value
WaveDifficulty 0.0
WaveDuration 90
WaveMask 105
WaveMaxMonsters 12

Default value, index 17:

Member Value
WaveDifficulty 0.5
WaveDuration 90
WaveMask 186
WaveMaxMonsters 12

Default value, index 18:

Member Value
WaveDifficulty 0.5
WaveDuration 90
WaveMask 225
WaveMaxMonsters 12

Default value, index 19:

Member Value
WaveDifficulty 0.5
WaveDuration 90
WaveMask 966
WaveMaxMonsters 12

Default value, index 20:

Member Value
WaveDifficulty 1.0
WaveDuration 120
WaveMask 4771
WaveMaxMonsters 12

Default value, index 21:

Member Value
WaveDifficulty 1.0
WaveDuration 120
WaveMask 917
WaveMaxMonsters 12

Default value, index 22:

Member Value
WaveDifficulty 1.0
WaveDuration 120
WaveMask 1689
WaveMaxMonsters 12

Default value, index 23:

Member Value
WaveDifficulty 1.0
WaveDuration 120
WaveMask 18260
WaveMaxMonsters 12

Internal variables[edit]

bWaveInProgress[edit]

Type: bool


FallbackMonster[edit]

Type: class<Monster>


FallbackMonsterClass[edit]

Type: string

Modifiers: config


Default value: "SkaarjPack.EliteKrall"

FinalWave[edit]

Type: int

Modifiers: config


Default value: 16

InitialWave[edit]

Type: int

Modifiers: config


InvasionBotNames[edit]

Type: string

Array size: 9


Default value, index 1: "Gorge"

Default value, index 2: "Cannonball"

Default value, index 3: "Annika"

Default value, index 4: "Riker"

Default value, index 5: "BlackJack"

Default value, index 6: "Sapphire"

Default value, index 7: "Jakob"

Default value, index 8: "Othello"

InvasionDescText[edit]

Type: string

Array size: 8 (INVPROPNUM)

Modifiers: localized


Default value, index 0: "Specify the first wave of incoming monsters for a map."

Default value, index 1: "Specify the final wave which must be defeated to complete a map."

Default value, index 2: "Configure the properties for each wave."

Default value, index 3: "Select the wave to configure"

Default value, index 4: "Place a check next to each monster which should be part of this wave."

Default value, index 5: "Maximum amount of monsters that may be in the map at one time."

Default value, index 6: "Length of time (in seconds) the wave should last."

Default value, index 7: "Adjusts the relative intelligence of the invaders"

InvasionEnd[edit]

Type: name

Array size: 6


Default value, index 0: 'SKAARJtermination'

Default value, index 1: 'SKAARJslaughter'

Default value, index 2: 'SKAARJextermination'

Default value, index 3: 'SKAARJerradication'

Default value, index 4: 'SKAARJbloodbath'

Default value, index 5: 'SKAARJannihilation'

InvasionEndSound[edit]

Type: Sound

Array size: 6

OBSOLETE

InvasionPropText[edit]

Type: string

Array size: 8 (INVPROPNUM)

Modifiers: localized


Default value, index 0: "Starting Wave"

Default value, index 1: "Final Wave"

Default value, index 2: "Wave Configuration"

Default value, index 3: "Invaders"

Default value, index 4: "Wave Number"

Default value, index 5: "Max Invaders"

Default value, index 6: "Duration"

Default value, index 7: "Difficulty"

LastKilledMonsterClass[edit]

Type: class<Monster>


MaxMonsters[edit]

Type: int


MonsterClass[edit]

Type: class<Monster>

Array size: 16

Bit field to determine which monsters appear in this wave.

Default value, index 0: Class'SkaarjPack.SkaarjPupae'

Default value, index 1: Class'SkaarjPack.RazorFly'

Default value, index 2: Class'SkaarjPack.Manta'

Default value, index 3: Class'SkaarjPack.Krall'

Default value, index 4: Class'SkaarjPack.EliteKrall'

Default value, index 5: Class'SkaarjPack.GasBag'

Default value, index 6: Class'SkaarjPack.Brute'

Default value, index 7: Class'SkaarjPack.Skaarj'


Default value, index 8: Class'SkaarjPack.Behemoth'

Default value, index 9: Class'SkaarjPack.IceSkaarj'

Default value, index 10: Class'SkaarjPack.FireSkaarj'

Default value, index 11: Class'SkaarjPack.Warlord'

Default value, index 12: Class'SkaarjPack.SkaarjPupae'

Default value, index 13: Class'SkaarjPack.SkaarjPupae'

Default value, index 14: Class'SkaarjPack.RazorFly'

Default value, index 15: Class'SkaarjPack.RazorFly'

NewRoundSound[edit]

Type: Sound

OBSOLETE

NextMonsterTime[edit]

Type: float


NumMonsters[edit]

Type: int


SecondBot[edit]

Type: int


WaveConfigMenu[edit]

Type: string

Modifiers: config


Default value: "GUI2K4.UT2K4InvasionWaveConfig"

WaveCountDown[edit]

Type: int


Default value: 15

WaveEndTime[edit]

Type: float


WaveMonsterClass[edit]

Type: class<Monster>

Array size: 16


WaveMonsters[edit]

Type: int


WaveNum[edit]

Type: int


WaveNumClasses[edit]

Type: int


Default values[edit]

Property Value
Acronym "INV"
bForceNoPlayerLights True
bPlayersMustBeReady True
DeathMessageClass Class'SkaarjPack.InvasionDeathMessage'
DefaultMaxLives 1
Description "Along side the other players, you must hold out as long as possible against the waves of attacking monsters."
EndGameSoundName[0] 'You_Have_Won_the_Match'
EndGameSoundName[1] 'You_Have_Lost_the_Match'
GameName "Invasion"
GameReplicationInfoClass Class'SkaarjPack.InvasionGameReplicationInfo'
GIPropDescText[0] "Set the skill of the invading monsters."
GIPropsDisplayText[0] "Monster Skill"
HUDType "Skaarjpack.HudInvasion"
InitialBots 2
LoginMenuClass "GUI2K4.UT2K4InvasionLoginMenu"
MapListType "Skaarjpack.MapListSkaarjInvasion"
MaxLives 1
MutatorClass "Skaarjpack.InvasionMutator"
ScoreBoardType "Skaarjpack.ScoreboardInvasion"
ScreenShotName "UT2004Thumbnails.InvasionShots"
SPBotDesc "Specify the number of bots (max 2 for invasion) that should join."
TeamAIType[0] Class'SkaarjPack.InvasionTeamAI'
TeamAIType[1] Class'SkaarjPack.InvasionTeamAI'

Structs[edit]

WaveInfo[edit]

int WaveMask 
bit fields for which monsters appear in this wave. See MonsterClass.
byte WaveMaxMonsters 
Used to set NewMaxMonsters, the upper limit of monsters for that round. Zero-based, so setting to 1 means "no monsters", 2 = only one monster, etc. Also influenced by NumPlayers, NumBots and GameDifficulty.
byte WaveDuration 
duration in minutes to complete this wave
float WaveDifficulty 
multiplier adjusting difficulty. Final AdjustedDifficulty is original GameDifficulty plus WaveDifficulty for that wave.

Functions[edit]

Static events[edit]

AcceptPlayInfoProperty[edit]

static event bool AcceptPlayInfoProperty (string PropertyName)

Overrides: TeamGame.AcceptPlayInfoProperty


GetDescriptionText[edit]

static event string GetDescriptionText (string PropName)

Overrides: TeamGame.GetDescriptionText


GetDisplayText[edit]

static event string GetDisplayText (string PropName)

Overrides: DeathMatch.GetDisplayText


Other static functions[edit]

FillPlayInfo[edit]

static function FillPlayInfo (PlayInfo PI)

Overrides: TeamGame.FillPlayInfo


PrecacheGameAnnouncements[edit]

static function PrecacheGameAnnouncements (AnnouncerVoice V, bool bRewardSounds)

Overrides: TeamGame.PrecacheGameAnnouncements


PrecacheGameTextures[edit]

static function PrecacheGameTextures (LevelInfo myLevel)

Overrides: xTeamGame.PrecacheGameTextures


Events[edit]

InitGame[edit]

event InitGame (string Options, out string Error)

Overrides: TeamGame.InitGame


Login[edit]

event PlayerController Login (string Portal, string Options, out string Error)

Overrides: DeathMatch.Login


PreBeginPlay[edit]

event PreBeginPlay ()

Overrides: GameInfo.PreBeginPlay


Other instance functions[edit]

AddMonster[edit]

function AddMonster ()


CanSpectate[edit]

function bool CanSpectate (PlayerController Viewer, bool bOnlySpectator, Actor ViewTarget)

Overrides: TeamGame.CanSpectate


CheckEndGame[edit]

function bool CheckEndGame (PlayerReplicationInfo Winner, string Reason)

Overrides: TeamGame.CheckEndGame


CheckMaxLives[edit]

function bool CheckMaxLives (PlayerReplicationInfo Scorer)

Overrides: TeamGame.CheckMaxLives


GetBotTeam[edit]

function UnrealTeamInfo GetBotTeam (optional int TeamBots)

Overrides: TeamGame.GetBotTeam


GetServerDetails[edit]

function GetServerDetails (out GameInfo.ServerResponseLine ServerState)

Overrides: TeamGame.GetServerDetails


Killed[edit]

function Killed (Controller Killer, Controller Killed, Pawn KilledPawn, class<DamageTypedamageType)

Overrides: DeathMatch.Killed


NotifyKilled[edit]

function NotifyKilled (Controller Killer, Controller Killed, Pawn KilledPawn)

Overrides: TeamGame.NotifyKilled


OverrideInitialBots[edit]

function OverrideInitialBots ()

Overrides: TeamGame.OverrideInitialBots


PickTeam[edit]

function byte PickTeam (byte num, Controller C)

Overrides: TeamGame.PickTeam


PlayEndOfMatchMessage[edit]

function PlayEndOfMatchMessage ()

Overrides: TeamGame.PlayEndOfMatchMessage


RatePlayerStart[edit]

function float RatePlayerStart (NavigationPoint N, byte Team, Controller Player)

Overrides: TeamGame.RatePlayerStart


ReduceDamage[edit]

function int ReduceDamage (int Damage, Pawn injured, Pawn instigatedBy, Object.Vector HitLocation, out Object.Vector Momentum, class<DamageTypeDamageType)

Overrides: TeamGame.ReduceDamage


ReplenishWeapons[edit]

function ReplenishWeapons (Pawn P)


RestartPlayer[edit]

function RestartPlayer (Controller aPlayer)

Overrides: TeamGame.RestartPlayer


ScoreKill[edit]

function ScoreKill (Controller Killer, Controller Other)

Overrides: TeamGame.ScoreKill


SetupRandomWave[edit]

function SetupRandomWave ()


SetupWave[edit]

function SetupWave ()


SpawnBot[edit]

function Bot SpawnBot (optional string botName)

Overrides: DeathMatch.SpawnBot


UpdateAnnouncements[edit]

simulated function UpdateAnnouncements ()

Overrides: TeamGame.UpdateAnnouncements


States[edit]

MatchInProgress[edit]

MatchInProgress.BeginState[edit]

event BeginState ()

Overrides: DeathMatch.MatchInProgress.beginstate


MatchInProgress.Timer[edit]

event Timer ()

Overrides: DeathMatch.MatchInProgress.Timer