Unreal Wiki - User contributions [en]

User:Rejecht/Getting Started UE4

2014-08-16T16:56:17Z

Rejecht: /* Unreal Engine 4 */

=== Unreal Engine 4 ===

==== Microsoft Visual Studio Express 2013 for Windows Desktop ====

[https://docs.unrealengine.com/latest/INT/Programming/Development/VisualStudioSetup/index.html Setting Up Visual Studio for UE4]

=== Protocol ===

[https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/index.html Coding Standard]

Naming Conventions * Methods * Style * Organization

[https://docs.unrealengine.com/latest/INT/Programming/Development/index.html Development Setup]

=== Replication ===

Game types and replicated values?

# Declare the UPROPERTY as replicated in C++
# Initialize the state of the variable in the game type constructor
# Declare the type of replication in the game type GetLifetimeReplicatedProps function

=== Low Level ===

==== Structure ====

Explains the basic client only {Camera, HUD}, client and server {Pawn, Character, PlayerState, GameState}, and server-only {Controller} junction points.

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/index.html Unreal Architecture]

==== Objects ====

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Objects/Optimizations/index.html Unreal Object Handling]
[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Objects/Optimizations/index.html UObject Instance Creation]

==== Pointers ====

When referring to something you use may shared pointers (pointer + reference count), shared references, or weak pointers.

The shared pointer types are optimal for higher level or lower frequency access.

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/SmartPointerLibrary/index.html Unreal Smart Pointer Library]

.IsValid() is used on shared pointers to check if they are NULL.

===== Usage Patterns =====

* Caching a pointer to something using a weak pointer does not touch reference counting thus requires a check against NULL before access (and it gets set to NULL automatically when the instance it points to gets destroyed).
* The shared pointer itself requires a check against IsValid before access.
* Custom C++ classes may want to implement FSerializableObject to handle reference counting when they refer to other UObject classes.
* Assigning NULL to a smart pointer may force a deletion of the object.

==== Actors ====

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Actors/Components/index.html Components]

===== Destruction =====

[https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/GameFramework/AActor/IsPendingKillPending/index.html IsPendingKillPending]

=== API Overview ===

https://docs.unrealengine.com/latest/INT/API/index.html

User:Rejecht/Getting Started UE4

2014-08-10T18:11:42Z

Rejecht: /* Actors */

=== Unreal Engine 4 ===

=== Protocol ===

[https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/index.html Coding Standard]

Naming Conventions * Methods * Style * Organization

[https://docs.unrealengine.com/latest/INT/Programming/Development/index.html Development Setup]

=== Replication ===

Game types and replicated values?

# Declare the UPROPERTY as replicated in C++
# Initialize the state of the variable in the game type constructor
# Declare the type of replication in the game type GetLifetimeReplicatedProps function

=== Low Level ===

==== Structure ====

Explains the basic client only {Camera, HUD}, client and server {Pawn, Character, PlayerState, GameState}, and server-only {Controller} junction points.

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/index.html Unreal Architecture]

==== Objects ====

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Objects/Optimizations/index.html Unreal Object Handling]
[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Objects/Optimizations/index.html UObject Instance Creation]

==== Pointers ====

When referring to something you use may shared pointers (pointer + reference count), shared references, or weak pointers.

The shared pointer types are optimal for higher level or lower frequency access.

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/SmartPointerLibrary/index.html Unreal Smart Pointer Library]

.IsValid() is used on shared pointers to check if they are NULL.

===== Usage Patterns =====

* Caching a pointer to something using a weak pointer does not touch reference counting thus requires a check against NULL before access (and it gets set to NULL automatically when the instance it points to gets destroyed).
* The shared pointer itself requires a check against IsValid before access.
* Custom C++ classes may want to implement FSerializableObject to handle reference counting when they refer to other UObject classes.
* Assigning NULL to a smart pointer may force a deletion of the object.

==== Actors ====

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Actors/Components/index.html Components]

===== Destruction =====

[https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/GameFramework/AActor/IsPendingKillPending/index.html IsPendingKillPending]

=== API Overview ===

https://docs.unrealengine.com/latest/INT/API/index.html

User:Rejecht/Getting Started UE4

2014-08-10T17:53:34Z

Rejecht: /* Actors */

=== Unreal Engine 4 ===

=== Protocol ===

[https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/index.html Coding Standard]

Naming Conventions * Methods * Style * Organization

[https://docs.unrealengine.com/latest/INT/Programming/Development/index.html Development Setup]

=== Replication ===

Game types and replicated values?

# Declare the UPROPERTY as replicated in C++
# Initialize the state of the variable in the game type constructor
# Declare the type of replication in the game type GetLifetimeReplicatedProps function

=== Low Level ===

==== Structure ====

Explains the basic client only {Camera, HUD}, client and server {Pawn, Character, PlayerState, GameState}, and server-only {Controller} junction points.

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/index.html Unreal Architecture]

==== Objects ====

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Objects/Optimizations/index.html Unreal Object Handling]
[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Objects/Optimizations/index.html UObject Instance Creation]

==== Pointers ====

When referring to something you use may shared pointers (pointer + reference count), shared references, or weak pointers.

The shared pointer types are optimal for higher level or lower frequency access.

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/SmartPointerLibrary/index.html Unreal Smart Pointer Library]

.IsValid() is used on shared pointers to check if they are NULL.

===== Usage Patterns =====

* Caching a pointer to something using a weak pointer does not touch reference counting thus requires a check against NULL before access (and it gets set to NULL automatically when the instance it points to gets destroyed).
* The shared pointer itself requires a check against IsValid before access.
* Custom C++ classes may want to implement FSerializableObject to handle reference counting when they refer to other UObject classes.
* Assigning NULL to a smart pointer may force a deletion of the object.

==== Actors ====

[https://docs.unrealengine.com/latest/INT/Programming/UnrealArchitecture/Actors/Components/index.html Components]

=== API Overview ===

https://docs.unrealengine.com/latest/INT/API/index.html

User:Rejecht/Getting Started UE4

2014-08-10T17:23:12Z

Rejecht: /* Pointers */

User:Rejecht/Getting Started UE4

2014-08-10T16:54:20Z

Rejecht: /* Structure */

User:Rejecht/Getting Started UE4

2014-08-10T16:52:54Z

Rejecht: /* Pointers */

User:Rejecht/Getting Started UE4

2014-08-10T16:51:06Z

Rejecht: /* Pointers */

User:Rejecht/Getting Started UE4

2014-08-10T16:37:20Z

Rejecht: /* Replication */

User:Rejecht/Getting Started UE4

2014-08-08T11:16:17Z

Rejecht:

User:Rejecht

2014-08-08T11:11:16Z

Rejecht: /* About */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Articles ===

[[User:Rejecht/Key_Bindings_(UT2004)]]

=== Where ===

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

=== UE 4 ===

[[User:Rejecht/Getting Started UE4]]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== ClientFlash does nothing ====

(It's used to fade all screen colors from a starting color.)

Check these dependencies:
#ScreenFlashes in UT2004.ini must be True for the driver you use.
#Check (ScreenFlashScaling > 0.0f) in User.ini.

If the settings check out, check if something prevents PlayerController.ViewFlash () from getting called.

==== Having no pawn is the same as being in a Dead state ====

The game has a hard-coded client-side rule that forces the player to enter a dead state when it does not find a Pawn.

Triggers:
* [NM_Standalone|NM_ListenServer|NM_Client] (Pawn == None)

Cause:
* PlayerController.(PlayerWalking)PlayerMove ()

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Servers do not know the locations of spectators ====

Spectators are in control of the location, and do not get sneaky state information, nor do they send location information to the server in the same way as a player with a pawn does.

The sources for UT3 1.5 try to solve this problem with ServerSetSpectatorLocation, however, this function can't possibly work as intended, as it does not update the position when the camera moves, but rather sets the last position and stays there. To track the camera, use PlayerCalcView, and throttle calls to your own ServerSetSpectatorLocation from the client (no need to call each tick). You also need to make sure PlayerMove (movement keys) does not offset the view from where the camera is, unless the player has freed the camera.

It is assumed that this has something to do with sounds not playing in the right location, but not yet proven.

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht/Getting Started UE4

2014-08-08T11:09:53Z

Rejecht: Created page with ''''Unreal Engine 4''' '''Protocol''' [https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/index.html Coding Standard] Naming Conventions * Method…'

'''Unreal Engine 4'''

'''Protocol'''

[https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/index.html Coding Standard]

Naming Conventions * Methods * Style * Organization

[https://docs.unrealengine.com/latest/INT/Programming/Development/index.html Development Setup]

Key Bindings (UT2004)

2014-08-01T21:39:11Z

Rejecht:

Source: DefUser.ini (UT2004v3369)

'''[Engine.Input]'''
<nowiki>
Aliases[0]=(Command="Button bFire | Fire",Alias=Fire)
Aliases[1]=(Command="Button bAltFire | AltFire",Alias=AltFire)
Aliases[2]=(Command="Axis aBaseY Speed=+300.0",Alias=MoveForward)
Aliases[3]=(Command="Axis aBaseY Speed=-300.0",Alias=MoveBackward)
Aliases[4]=(Command="Axis aBaseX Speed=-40.0",Alias=TurnLeft)
Aliases[5]=(Command="Axis aBaseX Speed=+40.0",Alias=TurnRight)
Aliases[6]=(Command="Axis aStrafe Speed=-300.0",Alias=StrafeLeft)
Aliases[7]=(Command="Axis aStrafe Speed=+300.0",Alias=StrafeRight)
Aliases[8]=(Command="Jump | Axis aUp Speed=+300.0",Alias=Jump)
Aliases[9]=(Command="Button bDuck | Axis aUp Speed=-300.0",Alias=Duck)
Aliases[10]=(Command="Button bLook",Alias=Look)
Aliases[11]=(Command="Toggle bLook",Alias=LookToggle)
Aliases[12]=(Command="ActivateItem",Alias=InventoryActivate)
Aliases[13]=(Command="NextItem",Alias=InventoryNext)
Aliases[14]=(Command="PrevItem",Alias=InventoryPrevious)
Aliases[15]=(Command="Axis aLookUp Speed=+25.0",Alias=LookUp)
Aliases[16]=(Command="Axis aLookUp Speed=-25.0",Alias=LookDown)
Aliases[17]=(Command="Button bSnapLevel",Alias=CenterView)
Aliases[18]=(Command="Button bRun",Alias=Walking)
Aliases[19]=(Command="Button bStrafe",Alias=Strafe)
Aliases[20]=(Command="NextWeapon",Alias=NextWeapon)
Aliases[21]=(Command="Button bFreeLook",Alias=FreeLook)
Aliases[22]=(Command="ViewClass Pawn",Alias=ViewTeam)
Aliases[23]=(Command="Button bTurnToNearest",Alias=TurnToNearest)
Aliases[24]=(Command="Button bTurn180",Alias=Turn180)
Aliases[25]=(Command="ShowScores|OnRelease ShowScores",Alias=ScoreToggle)
Aliases[26]=(Command="InGameChat",Alias=InGameChat)
Aliases[27]=(Command="ServerInfo",Alias=ServerInfo)
Aliases[28]=(Command="Button bVoiceTalk",Alias=VoiceTalk)
Aliases[29]=(Command="Speak Team|Button bVoiceTalk|OnRelease SpeakLast",Alias=ToggleTeamChat)
Aliases[30]=(Command="Speak Local|Button bVoiceTalk|OnRelease SpeakLast",Alias=ToggleLocalChat)
Aliases[31]=(Command="Speak Public|Button bVoiceTalk|OnRelease SpeakLast",Alias=TogglePublicChat)
Aliases[32]=(Command="Axis aBaseX SpeedBase=100.0 DeadZone=0.1",Alias="SpaceFighter_JoyX")
Aliases[33]=(Command="Axis aLookUp SpeedBase=100.0 DeadZone=0.1",Alias="SpaceFighter_JoyY")
Aliases[34]=(Command="Axis aUp Speed=+300.0 | Axis aStrafe SpeedBase=300.0 DeadZone=0.1",Alias="SpaceFighter_JoyV")
Aliases[35]=(Command="Axis aBaseY SpeedBase=300.0 DeadZone=0.1 Invert=-1",Alias="SpaceFighter_JoySlider1")
Aliases[36]=(Command="",Alias=None)
Aliases[37]=(Command="",Alias=None)
Aliases[38]=(Command="",Alias=None)
Aliases[39]=(Command="",Alias=None)

0=SwitchWeapon 0
1=SwitchWeapon 1
2=SwitchWeapon 2
3=SwitchWeapon 3
4=SwitchWeapon 4
5=SwitchWeapon 5
6=SwitchWeapon 6
7=SwitchWeapon 7
8=SwitchWeapon 8
9=SwitchWeapon 9

F1=ShowScores
F2=InGameChat
F3=ShowStats
F4=ToggleBehindView
F5=ToggleFreeCam
F6=Stat Net
F7=ToggleFreeCamSwivel
F8=NextStats
F9=shot
F10=Cancel
F11=MusicMenu
F12=ToggleRadarMap
F13=
F14=
F15=
F16=
F17=
F18=
F19=
F20=
F21=
F22=
F23=
F24=AltFire

A=StrafeLeft
B=SwitchToLastWeapon
C=Duck
D=StrafeRight
E=Use
F=VoiceTalk
G=SwitchToBestWeapon
H=
I=ToggleTeamChat
j=Taunt pthrust
K=Taunt asssmack
L=Taunt throatcut
M=BasePath 0
N=BasePath 1
O=ToggleLocalChat
P=TogglePublicChat
Q=SwitchWeapon 10
R=TeamTalk
S=MoveBackward
T=Talk
U=Use
V=SpeechMenuToggle
W=MoveForward
X=ShowVoteMenu
Y=writetolog
Z=Strafe

Alt=
Attn=
Backslash=ThrowWeapon
Backspace=Jump
Cancel=
CapsLock=LookToggle
Comma=StrafeLeft
CrSel=
Ctrl=Jump
Delete=LookUp
Down=MoveBackward
End=CenterView|ACTOR ALIGN SNAPTOFLOOR ALIGN=1
Enter=Use
Equals=GrowHUD
Escape=ShowMenu
ErEof=
Execute=
ExSel=
GreySlash=
GreyStar=
GreyMinus=
GreyPlus=
Help=
home=
Insert=
LControl=
Left=StrafeLeft
LeftBracket=InventoryPrevious
LShift=
Minus=ShrinkHUD
NoName=
None=
OemClear=
PA1=
PageDown=LookDown
PageUp=
Pause=Pause
Period=StrafeRight
Play=
Print=
PrintScrn=
RControl=
Right=StrafeRight
RightBracket=InventoryNext
RShift=
ScrollLock=
Select=
Semicolon=Taunt gesture_point
Separator=
Shift=Duck
SingleQuote=Strafe
Slash=NextWeapon
Space=Jump
Tab=Type
Tilde=ConsoleToggle
Up=MoveForward
Zoom=

LeftMouse=Fire
MiddleMouse=MoveForward
RightMouse=AltFire
MouseWheelDown=NextWeapon
MouseWheelUp=PrevWeapon
MouseX=Count bXAxis | Axis aMouseX Speed=2.0
MouseY=Count bYAxis | Axis aMouseY Speed=2.0
MouseZ=

NumLock=
NumPad7=StrafeLeft
NumPad8=MoveForward
NumPad9=StrafeRight
NumPadPeriod=

Joy1=Fire
Joy2=Jump
Joy3=AltFire
Joy4=Duck
Joy5=NextWeapon
Joy6=SwitchWeapon 2
Joy7=SwitchWeapon 3
Joy8=SwitchWeapon 4
Joy9=SwitchWeapon 9
Joy10=SwitchWeapon 0
Joy11=InventoryPrevious
Joy12=InventoryActivate
Joy13=MoveForward
Joy14=StrafeRight
Joy15=MoveBackward
Joy16=StrafeLeft
JoyX=Axis aStrafe SpeedBase=300.0 DeadZone=0.1
JoyY=Axis aBaseY SpeedBase=300.0 DeadZone=0.1 Invert=-1
JoyZ=
JoyR=
JoyU=
JoyV=Axis aBaseX SpeedBase=2.0 DeadZone=0.4
JoySlider1=Axis aLookUp SpeedBase=2.0 DeadZone=0.4
JoySlider2=</nowiki>

Key Bindings (UT2004)

2014-08-01T21:38:47Z

Rejecht:

Source: DefUser.ini (UT2004v3369)

<nowiki>'''[Engine.Input]'''
Aliases[0]=(Command="Button bFire | Fire",Alias=Fire)
Aliases[1]=(Command="Button bAltFire | AltFire",Alias=AltFire)
Aliases[2]=(Command="Axis aBaseY Speed=+300.0",Alias=MoveForward)
Aliases[3]=(Command="Axis aBaseY Speed=-300.0",Alias=MoveBackward)
Aliases[4]=(Command="Axis aBaseX Speed=-40.0",Alias=TurnLeft)
Aliases[5]=(Command="Axis aBaseX Speed=+40.0",Alias=TurnRight)
Aliases[6]=(Command="Axis aStrafe Speed=-300.0",Alias=StrafeLeft)
Aliases[7]=(Command="Axis aStrafe Speed=+300.0",Alias=StrafeRight)
Aliases[8]=(Command="Jump | Axis aUp Speed=+300.0",Alias=Jump)
Aliases[9]=(Command="Button bDuck | Axis aUp Speed=-300.0",Alias=Duck)
Aliases[10]=(Command="Button bLook",Alias=Look)
Aliases[11]=(Command="Toggle bLook",Alias=LookToggle)
Aliases[12]=(Command="ActivateItem",Alias=InventoryActivate)
Aliases[13]=(Command="NextItem",Alias=InventoryNext)
Aliases[14]=(Command="PrevItem",Alias=InventoryPrevious)
Aliases[15]=(Command="Axis aLookUp Speed=+25.0",Alias=LookUp)
Aliases[16]=(Command="Axis aLookUp Speed=-25.0",Alias=LookDown)
Aliases[17]=(Command="Button bSnapLevel",Alias=CenterView)
Aliases[18]=(Command="Button bRun",Alias=Walking)
Aliases[19]=(Command="Button bStrafe",Alias=Strafe)
Aliases[20]=(Command="NextWeapon",Alias=NextWeapon)
Aliases[21]=(Command="Button bFreeLook",Alias=FreeLook)
Aliases[22]=(Command="ViewClass Pawn",Alias=ViewTeam)
Aliases[23]=(Command="Button bTurnToNearest",Alias=TurnToNearest)
Aliases[24]=(Command="Button bTurn180",Alias=Turn180)
Aliases[25]=(Command="ShowScores|OnRelease ShowScores",Alias=ScoreToggle)
Aliases[26]=(Command="InGameChat",Alias=InGameChat)
Aliases[27]=(Command="ServerInfo",Alias=ServerInfo)
Aliases[28]=(Command="Button bVoiceTalk",Alias=VoiceTalk)
Aliases[29]=(Command="Speak Team|Button bVoiceTalk|OnRelease SpeakLast",Alias=ToggleTeamChat)
Aliases[30]=(Command="Speak Local|Button bVoiceTalk|OnRelease SpeakLast",Alias=ToggleLocalChat)
Aliases[31]=(Command="Speak Public|Button bVoiceTalk|OnRelease SpeakLast",Alias=TogglePublicChat)
Aliases[32]=(Command="Axis aBaseX SpeedBase=100.0 DeadZone=0.1",Alias="SpaceFighter_JoyX")
Aliases[33]=(Command="Axis aLookUp SpeedBase=100.0 DeadZone=0.1",Alias="SpaceFighter_JoyY")
Aliases[34]=(Command="Axis aUp Speed=+300.0 | Axis aStrafe SpeedBase=300.0 DeadZone=0.1",Alias="SpaceFighter_JoyV")
Aliases[35]=(Command="Axis aBaseY SpeedBase=300.0 DeadZone=0.1 Invert=-1",Alias="SpaceFighter_JoySlider1")
Aliases[36]=(Command="",Alias=None)
Aliases[37]=(Command="",Alias=None)
Aliases[38]=(Command="",Alias=None)
Aliases[39]=(Command="",Alias=None)

0=SwitchWeapon 0
1=SwitchWeapon 1
2=SwitchWeapon 2
3=SwitchWeapon 3
4=SwitchWeapon 4
5=SwitchWeapon 5
6=SwitchWeapon 6
7=SwitchWeapon 7
8=SwitchWeapon 8
9=SwitchWeapon 9

F1=ShowScores
F2=InGameChat
F3=ShowStats
F4=ToggleBehindView
F5=ToggleFreeCam
F6=Stat Net
F7=ToggleFreeCamSwivel
F8=NextStats
F9=shot
F10=Cancel
F11=MusicMenu
F12=ToggleRadarMap
F13=
F14=
F15=
F16=
F17=
F18=
F19=
F20=
F21=
F22=
F23=
F24=AltFire

A=StrafeLeft
B=SwitchToLastWeapon
C=Duck
D=StrafeRight
E=Use
F=VoiceTalk
G=SwitchToBestWeapon
H=
I=ToggleTeamChat
j=Taunt pthrust
K=Taunt asssmack
L=Taunt throatcut
M=BasePath 0
N=BasePath 1
O=ToggleLocalChat
P=TogglePublicChat
Q=SwitchWeapon 10
R=TeamTalk
S=MoveBackward
T=Talk
U=Use
V=SpeechMenuToggle
W=MoveForward
X=ShowVoteMenu
Y=writetolog
Z=Strafe

Alt=
Attn=
Backslash=ThrowWeapon
Backspace=Jump
Cancel=
CapsLock=LookToggle
Comma=StrafeLeft
CrSel=
Ctrl=Jump
Delete=LookUp
Down=MoveBackward
End=CenterView|ACTOR ALIGN SNAPTOFLOOR ALIGN=1
Enter=Use
Equals=GrowHUD
Escape=ShowMenu
ErEof=
Execute=
ExSel=
GreySlash=
GreyStar=
GreyMinus=
GreyPlus=
Help=
home=
Insert=
LControl=
Left=StrafeLeft
LeftBracket=InventoryPrevious
LShift=
Minus=ShrinkHUD
NoName=
None=
OemClear=
PA1=
PageDown=LookDown
PageUp=
Pause=Pause
Period=StrafeRight
Play=
Print=
PrintScrn=
RControl=
Right=StrafeRight
RightBracket=InventoryNext
RShift=
ScrollLock=
Select=
Semicolon=Taunt gesture_point
Separator=
Shift=Duck
SingleQuote=Strafe
Slash=NextWeapon
Space=Jump
Tab=Type
Tilde=ConsoleToggle
Up=MoveForward
Zoom=

LeftMouse=Fire
MiddleMouse=MoveForward
RightMouse=AltFire
MouseWheelDown=NextWeapon
MouseWheelUp=PrevWeapon
MouseX=Count bXAxis | Axis aMouseX Speed=2.0
MouseY=Count bYAxis | Axis aMouseY Speed=2.0
MouseZ=

NumLock=
NumPad7=StrafeLeft
NumPad8=MoveForward
NumPad9=StrafeRight
NumPadPeriod=

Joy1=Fire
Joy2=Jump
Joy3=AltFire
Joy4=Duck
Joy5=NextWeapon
Joy6=SwitchWeapon 2
Joy7=SwitchWeapon 3
Joy8=SwitchWeapon 4
Joy9=SwitchWeapon 9
Joy10=SwitchWeapon 0
Joy11=InventoryPrevious
Joy12=InventoryActivate
Joy13=MoveForward
Joy14=StrafeRight
Joy15=MoveBackward
Joy16=StrafeLeft
JoyX=Axis aStrafe SpeedBase=300.0 DeadZone=0.1
JoyY=Axis aBaseY SpeedBase=300.0 DeadZone=0.1 Invert=-1
JoyZ=
JoyR=
JoyU=
JoyV=Axis aBaseX SpeedBase=2.0 DeadZone=0.4
JoySlider1=Axis aLookUp SpeedBase=2.0 DeadZone=0.4
JoySlider2=</nowiki>

Talk:Key Bindings (UT2004)

2014-08-01T21:35:18Z

Rejecht:

What's the purpose of this page? It's an orphan and its information doesn't quite look like it'd be useful for editing directly. On the UnrealWiki you'd probably expect a DefUser.ini dump instead, while the pretty-colored textual representation is more a thing for Liandri Archives. —[[User:Wormbo|Wormbo]] 20:06, 1 August 2014 (UTC)

Not sure where to link this in, and nevermind the stylish stuff. I basically wanted to have a page to refer to when it comes to key bindings. I'll keep the current version under my user page and replace this one with a preliminary DefUser.ini copy/paste for now. --[[User:Rejecht|Rejecht]] 21:35, 1 August 2014 (UTC)

Key Bindings (UT2004)

2014-08-01T18:48:56Z

Rejecht: Created page with 'Note: Based on a Norwegian keyboard layout thus showing æ, ø (oslash), å (aring) and TDLR (I assume "tødler"). {| class="wikitable" style="text-align: center; background-col…'

Note: Based on a Norwegian keyboard layout thus showing æ, ø (oslash), å (aring) and TDLR (I assume "tødler").

{| class="wikitable" style="text-align: center; background-color: #0B3B6A; color: #FFB900; font-weight: bold;"
! Action
! Key 1
! Key 2
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Movement
|-
| Forward
| W
| Up
|-
| Backward
| S
| Down
|-
| Strafe Left
| A
| Left
|-
| Strafe Right
| D
| Right
|-
| Jump
| CTRL
| Space
|-
| Walk
|
|
|-
| Crouch
| C
| Shift
|-
| Strafe Toggle
| Z
| æ
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Looking
|-
| Turn Left
|
|
|-
| Turn Right
|
|
|-
| Look Up
| Delete
|
|-
| Look Down
| Page Down
|
|-
| Center View
|
|
|-
| Toggle "BehindView"
| F4
|
|-
| Toggle Camera Mode
| F5
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Weapons
|-
| Fire
| Left Mouse Button
| Joy 1
|-
| Alt-Fire
| Right Mouse Button
| F24
|-
| Throw Weapon
| |
|
|-
| Best Weapon
| G
|
|-
| Next Weapon
| Mouse Wheel Down
| '
|-
| Previous Weapon
| Mouse Wheel Up
|
|-
| Last Weapon
| B
|
|-
| Weapon Selection
|
|
|-
| Super Weapon
| 0
| Joy 10
|-
| Shield Gun
| 1
|
|-
| Assault Rifle
| 2
| Joy 6
|-
| Bio-Rifle
| 3
| Joy 7
|-
| Shock Rifle
| 4
| Joy 8
|-
| Link Gun
| 5
|
|-
| Minigun
| 6
|
|-
| Flak Cannon
| 7
|
|-
| Rocket Launcher
| 8
|
|-
| Lightning Rifle
| 9
| Joy 9
|-
| Translocator
| Q
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Communication
|-
| Say
| T
|
|-
| Team Say
| R
|
|-
| In-Game Chat
| F2
|
|-
| Toggle Speech Menu
| V
|
|-
| Activate Microphone
| F
|
|-
| Speak in Public Channel
|
|
|-
| Speak in Local Channel
|
|
|-
| Speak in Team Channel
|
|
|-
| Toggle Public Channel
| P
|
|-
| Toggle Local Channel
| O
|
|-
| Toggle Team Channel
| I
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Taunts
|-
| Pelvic Thrust
| J
|
|-
| Ass Smack
| K
|
|-
| Throat Cut
| L
|
|-
| Brag
| "TDLR"
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | HUD
|-
| Grow HUD
| +
|
|-
| Shrink HUD
| -
|
|-
| Toggle Radar Map
| F12
|
|-
| Toggle Scoreboard
| F1
|
|-
| Scoreboard
|
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Game
|-
| Use
| E
| U
|-
| Pause
| Pause
|
|-
| Take Screen Shot
| F9
|
|-
| Find Red Base
| M
|
|-
| Find Blue Base
| N
|
|-
| Next Inventory Item
| å
|
|-
| Previous Inventory Item
| Joy 11
| \
|-
| Activate Current Inventory Item
| Joy 12
|
|-
| Show Personal Stats
| F3
|
|-
| View Next Player's Stats
| F8
|
|-
| Server Info
|
|
|-
| Vehicle Horn
|
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Miscellaneous
|-
| Toggle Menu
| Escape
|
|-
| Music Player
| F11
|
|-
| Voting Menu
| X
|
|-
| Toggle Console
| ø
|
|-
| Toggle Connection Status
| F6
|
|-
| Cancel Pending Connection
| F10
|
|}

User:Rejecht

2014-07-31T17:55:30Z

Rejecht: Removed forums, added link to article

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Articles ===

[[User:Rejecht/Key_Bindings_(UT2004)]]

=== Where ===

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== ClientFlash does nothing ====

(It's used to fade all screen colors from a starting color.)

Check these dependencies:
#ScreenFlashes in UT2004.ini must be True for the driver you use.
#Check (ScreenFlashScaling > 0.0f) in User.ini.

If the settings check out, check if something prevents PlayerController.ViewFlash () from getting called.

==== Having no pawn is the same as being in a Dead state ====

The game has a hard-coded client-side rule that forces the player to enter a dead state when it does not find a Pawn.

Triggers:
* [NM_Standalone|NM_ListenServer|NM_Client] (Pawn == None)

Cause:
* PlayerController.(PlayerWalking)PlayerMove ()

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Servers do not know the locations of spectators ====

Spectators are in control of the location, and do not get sneaky state information, nor do they send location information to the server in the same way as a player with a pawn does.

The sources for UT3 1.5 try to solve this problem with ServerSetSpectatorLocation, however, this function can't possibly work as intended, as it does not update the position when the camera moves, but rather sets the last position and stays there. To track the camera, use PlayerCalcView, and throttle calls to your own ServerSetSpectatorLocation from the client (no need to call each tick). You also need to make sure PlayerMove (movement keys) does not offset the view from where the camera is, unless the player has freed the camera.

It is assumed that this has something to do with sounds not playing in the right location, but not yet proven.

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht/Key Bindings (UT2004)

2014-07-31T15:04:52Z

Rejecht: Created page with '{| class="wikitable" style="text-align: center; background-color: #0B3B6A; color: #FFB900; font-weight: bold;" ! Action ! Key 1 ! Key 2 |- | style="background-color: #18184A; tex…'

{| class="wikitable" style="text-align: center; background-color: #0B3B6A; color: #FFB900; font-weight: bold;"
! Action
! Key 1
! Key 2
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Movement
|-
| Forward
| W
| Up
|-
| Backward
| S
| Down
|-
| Strafe Left
| A
| Left
|-
| Strafe Right
| D
| Right
|-
| Jump
| CTRL
| Space
|-
| Walk
|
|
|-
| Crouch
| C
| Shift
|-
| Strafe Toggle
| Z
| æ
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Looking
|-
| Turn Left
|
|
|-
| Turn Right
|
|
|-
| Look Up
| Delete
|
|-
| Look Down
| Page Down
|
|-
| Center View
|
|
|-
| Toggle "BehindView"
| F4
|
|-
| Toggle Camera Mode
| F5
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Weapons
|-
| Fire
| Left Mouse Button
| Joy 1
|-
| Alt-Fire
| Right Mouse Button
| F24
|-
| Throw Weapon
| |
|
|-
| Best Weapon
| G
|
|-
| Next Weapon
| Mouse Wheel Down
| '
|-
| Previous Weapon
| Mouse Wheel Up
|
|-
| Last Weapon
| B
|
|-
| Weapon Selection
|
|
|-
| Super Weapon
| 0
| Joy 10
|-
| Shield Gun
| 1
|
|-
| Assault Rifle
| 2
| Joy 6
|-
| Bio-Rifle
| 3
| Joy 7
|-
| Shock Rifle
| 4
| Joy 8
|-
| Link Gun
| 5
|
|-
| Minigun
| 6
|
|-
| Flak Cannon
| 7
|
|-
| Rocket Launcher
| 8
|
|-
| Lightning Rifle
| 9
| Joy 9
|-
| Translocator
| Q
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Communication
|-
| Say
| T
|
|-
| Team Say
| R
|
|-
| In-Game Chat
| F2
|
|-
| Toggle Speech Menu
| V
|
|-
| Activate Microphone
| F
|
|-
| Speak in Public Channel
|
|
|-
| Speak in Local Channel
|
|
|-
| Speak in Team Channel
|
|
|-
| Toggle Public Channel
| P
|
|-
| Toggle Local Channel
| O
|
|-
| Toggle Team Channel
| I
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Taunts
|-
| Pelvic Thrust
| J
|
|-
| Ass Smack
| K
|
|-
| Throat Cut
| L
|
|-
| Brag
| "TDLR"
|
|-
| colspan="3" | HUD
|-
| Grow HUD
| +
|
|-
| Shrink HUD
| -
|
|-
| Toggle Radar Map
| F12
|
|-
| Toggle Scoreboard
| F1
|
|-
| Scoreboard
|
|
|-
| colspan="3" | Game
|-
| Use
| E
| U
|-
| Pause
| Pause
|
|-
| Take Screen Shot
| F9
|
|-
| Find Red Base
| M
|
|-
| Find Blue Base
| N
|
|-
| Next Inventory Item
| å
|
|-
| Previous Inventory Item
| Joy 11
| \
|-
| Activate Current Inventory Item
| Joy 12
|
|-
| Show Personal Stats
| F3
|
|-
| View Next Player's Stats
| F8
|
|-
| Server Info
|
|
|-
| Vehicle Horn
|
|
|-
| style="background-color: #18184A; text-align: left;" colspan="3" | Miscellaneous
|-
| Toggle Menu
| Escape
|
|-
| Music Player
| F11
|
|-
| Voting Menu
| X
|
|-
| Toggle Console
| ø
|
|-
| Toggle Connection Status
| F6
|
|-
| Cancel Pending Connection
| F10
|
|}

UE2:FileLog (UT2004)

2014-06-30T19:06:17Z

Rejecht: Added Warning

{{infobox class
| package = Engine
| parent1 = Info
| parent2 = Actor
| parent3 = Object
}}
{{autogenerated}}
Class: Engine.FileLog
Parent: Engine.Info

Creates a log device.
Important notes about this class since version 2225:
- the log file is always closed when destroyed
- open log files have the extention .tmp and change to .log when
closed
- old .tmp files will be overwritten
- limited freedom in file extentions, allowed extentions:
log, txt, html, htm

==Properties==
====LogAr====
'''Type:''' [[pointer]]



====LogFileName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' const



====TempFileName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' const



==Native functions==
====CloseLog====
{{code|native final function '''CloseLog''' ()}}



====Logf====
{{code|native final function '''Logf''' ([[string]] '''LogString''')}}

Writes LogString to the file.

'''Warning''': This function will crash the instance--or possibly corrupt memory enough to cause a crash on exit or garbage collection--if a string is longer than 1024 characters or somewhere above that number. Your script should work around this issue by splitting the LogString up before passing it to this function.

====OpenLog====
{{code|native final function '''OpenLog''' ([[string]] '''FName''', optional [[string]] '''FExt''', optional [[bool]] '''bOverwrite''')}}

User:Rejecht

2013-12-25T13:05:52Z

Rejecht: /* ClientFlash does nothing */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== ClientFlash does nothing ====

(It's used to fade all screen colors from a starting color.)

Check these dependencies:
#ScreenFlashes in UT2004.ini must be True for the driver you use.
#Check (ScreenFlashScaling > 0.0f) in User.ini.

If the settings check out, check if something prevents PlayerController.ViewFlash () from getting called.

==== Having no pawn is the same as being in a Dead state ====

The game has a hard-coded client-side rule that forces the player to enter a dead state when it does not find a Pawn.

Triggers:
* [NM_Standalone|NM_ListenServer|NM_Client] (Pawn == None)

Cause:
* PlayerController.(PlayerWalking)PlayerMove ()

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Servers do not know the locations of spectators ====

Spectators are in control of the location, and do not get sneaky state information, nor do they send location information to the server in the same way as a player with a pawn does.

The sources for UT3 1.5 try to solve this problem with ServerSetSpectatorLocation, however, this function can't possibly work as intended, as it does not update the position when the camera moves, but rather sets the last position and stays there. To track the camera, use PlayerCalcView, and throttle calls to your own ServerSetSpectatorLocation from the client (no need to call each tick). You also need to make sure PlayerMove (movement keys) does not offset the view from where the camera is, unless the player has freed the camera.

It is assumed that this has something to do with sounds not playing in the right location, but not yet proven.

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-12-25T13:04:53Z

Rejecht: /* Having no pawn is the same as being in a Dead state */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== ClientFlash does nothing ====

(It's used to fade all screen colors from a starting color.)

Check these dependencies:
1. ScreenFlashes in UT2004.ini must be True for the driver you use.
2. Check (ScreenFlashScaling > 0.0f) in User.ini.

If the settings check out, check if something prevents PlayerController.ViewFlash () from getting called.

==== Having no pawn is the same as being in a Dead state ====

The game has a hard-coded client-side rule that forces the player to enter a dead state when it does not find a Pawn.

Triggers:
* [NM_Standalone|NM_ListenServer|NM_Client] (Pawn == None)

Cause:
* PlayerController.(PlayerWalking)PlayerMove ()

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Servers do not know the locations of spectators ====

Spectators are in control of the location, and do not get sneaky state information, nor do they send location information to the server in the same way as a player with a pawn does.

The sources for UT3 1.5 try to solve this problem with ServerSetSpectatorLocation, however, this function can't possibly work as intended, as it does not update the position when the camera moves, but rather sets the last position and stays there. To track the camera, use PlayerCalcView, and throttle calls to your own ServerSetSpectatorLocation from the client (no need to call each tick). You also need to make sure PlayerMove (movement keys) does not offset the view from where the camera is, unless the player has freed the camera.

It is assumed that this has something to do with sounds not playing in the right location, but not yet proven.

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-11-03T10:46:30Z

Rejecht: /* xPawn.ChangedWeapon breaks simulated function chain */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== Having no pawn is the same as being in a Dead state ====

The game has a hard-coded client-side rule that forces the player to enter a dead state when it does not find a Pawn.

Triggers:
* [NM_Standalone|NM_ListenServer|NM_Client] (Pawn == None)

Cause:
* PlayerController.(PlayerWalking)PlayerMove ()

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Servers do not know the locations of spectators ====

Spectators are in control of the location, and do not get sneaky state information, nor do they send location information to the server in the same way as a player with a pawn does.

The sources for UT3 1.5 try to solve this problem with ServerSetSpectatorLocation, however, this function can't possibly work as intended, as it does not update the position when the camera moves, but rather sets the last position and stays there. To track the camera, use PlayerCalcView, and throttle calls to your own ServerSetSpectatorLocation from the client (no need to call each tick). You also need to make sure PlayerMove (movement keys) does not offset the view from where the camera is, unless the player has freed the camera.

It is assumed that this has something to do with sounds not playing in the right location, but not yet proven.

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-11-03T10:38:45Z

Rejecht: /* NumLives is not the number of lives */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== Having no pawn is the same as being in a Dead state ====

The game has a hard-coded client-side rule that forces the player to enter a dead state when it does not find a Pawn.

Triggers:
* [NM_Standalone|NM_ListenServer|NM_Client] (Pawn == None)

Cause:
* PlayerController.(PlayerWalking)PlayerMove ()

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-11-03T10:35:41Z

Rejecht: /* Players who are out can sometimes respawn */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== xPawn.ChangedWeapon breaks simulated function chain ====

Pawn.ChangedWeapon is declared simulated, however, in the derived xPawn class, it is redeclared non-simulated while still being called from simulated functions, thus breaking the chain until the Pawn becomes ROLE_AutonomousProxy, which may take some time in netplay.

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-04-13T11:19:49Z

Rejecht: /* Countless Hours Wasted */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

==== Demo Recording & Playback ====

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-04-13T11:19:31Z

Rejecht: /* Countless Hours Wasted */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots, so it was never a bug in the mod, but my lack of awareness of this issue in the first place.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-04-13T11:18:48Z

Rejecht:

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Countless Hours Wasted ===

# Playing back a demo recorded in a networked game results in several text messages being duplicated. For example, orders sent to bots.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2013-02-24T16:23:08Z

Rejecht: Using a bitwise or operator: Added clarification and real-world application

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

Also note that this is a bad real-world example, because all channel values are always odd numbers. For example, if the red channel value is 50, the color code becomes 51. See the second example for the real world use of such a function, or you care about accuracy.

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

For the sake of completeness, a version that applies to the real world, using Max to keep the value within the allowed range [1, 255].

<uscript>function string GetText_ColorCode (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Max (Color.R, 1))
$ Chr (Max (Color.G, 1))
$ Chr (Max (Color.B, 1))
);
}</uscript>

User:Rejecht

2012-10-15T18:28:05Z

Rejecht: /* Added: Example: Using a bitwise and operator III */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise and operator III===
To show that you are not testing against the bit number, but a value. You have to compare using powers of two.
<uscript>function Example ()
{
local int Index;

Index = 255;

if ((Index & 128) == 128) // Test if bit #7 (2^7 = 128) is set. You have to compare and check using powers of two.
{
Log ("["$Index$"] Set"); // Bit #7 was set
}
else
{
Log ("["$Index$"] Cleared"); // Bit #7 was cleared
}
}

// Output:
// ScriptLog: [255] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-10-15T18:23:16Z

Rejecht: /* Example: Using a bitwise and operator II */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set. You have to compare using powers of two.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-10-07T16:21:13Z

Rejecht: /* About */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]

== Mods ==

An overview of mods (game types, maps, mutators) can be found on [https://sites.google.com/site/rejecht/ rejecht's notes].

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-10-07T16:13:13Z

Rejecht: /* About */

== About ==

Haphazard hobbyist programming sessions since about 1992.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]
* rejecht on [http://www.moddb.com/members/rejecht ModDB]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-08-05T05:11:36Z

Rejecht: /* ImportText && "Bad termination in:" */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== General Protection Fault ====

History:
# FScriptCompiler::CompileConst
# <- Const
# <- FScriptCompiler::CompileDeclaration
# <- FScriptCompiler::CompileStatement
# <- FirstPass
# <- TryCompile
# <- FScriptCompiler::CompileScript
# <- (Class PackageName.ClassName, Pass 0, Line %Line_Number%)
# <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript <- MakeScript
# <- DoScripts
# <- UEditorEngine::MakeScripts
# <- UMakeCommandlet::Main

Cause:
* Declaring the same variable name as const value twice.

File content example:
<UScript>
class Example extends Actor;

const crash = 1;
const crash = 2; // Cause of crash.</UScript>

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-08-05T04:47:46Z

Rejecht: /* ImportText && "Bad termination in:" */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.
* The compiler probably uses a static text buffer of 4096 characters per line.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-08-05T04:43:20Z

Rejecht: /* ImportText && "Bad termination in:" */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.

Solutions:
# Partition up the dynamic array into groups of dynamic arrays (acceptable).
# Change over to a static array - replace '''Count = ArrayVariableName.Length''' with '''Count = ArrayCount (ArrayVariableName)'''.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-08-05T04:38:26Z

Rejecht: /* ImportText && "Bad termination in:" */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as '''"Bad termination in:"''' at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-08-05T04:37:41Z

Rejecht: /* ImportText && "Bad termination in:" */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as [["Bad termination in:"]] at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.
* Elements in a static array are serialized to a single line per element.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-08-05T04:33:49Z

Rejecht: /* Unreal Tournament 2004 Bugs || Errors */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 - Compiler Errors ===

==== ImportText && "Bad termination in:" ====

Problem:
* A dynamic array with a lot of elements will not be stored correctly in the resulting int file.

Cause:
* The compiler cuts off the dynamic array after 4096 characters. After the 4096th character, the int file will contain garbage. This is in turn logged by '''ImportText''' upon accessing the dynamic array as [["Bad termination in:"]] at runtime.

Trivia:
* Elements in a dynamic array are serialized to a single line in an int file.

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-05-27T07:10:33Z

Rejecht: /* Tips */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

==Tips==

===Example: Using a bitwise and operator===

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

===Example: Using a bitwise and operator II===

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

===Example: Using a bitwise or operator===

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-05-27T07:09:56Z

Rejecht: /* Tips */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

=Tips=

==Example: Using a bitwise and operator==

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

==Example: Using a bitwise and operator II==

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

==Example: Using a bitwise or operator==

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

User:Rejecht

2012-05-27T07:09:19Z

Rejecht: /* (...) more to come. */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

'''Fora'''

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forum]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forum]
* rejecht on [http://www.tcpclan.net/phpforum/profile.php?mode=viewprofile&u=566 The Clan Punishers Forum]
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forum]

'''Other'''

* rejecht on [https://twitter.com/#!/rejecht Twitter]

'''Websites'''

* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Count_TeamSymbols - 1);
Index_TeamSymbol[1] = Rand (Count_TeamSymbols - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a metaclass reference (Syntax: Class<Classname>).
* Use IsA with an instance of a class.

Trivia:
* I don't think the actual drowning sounds were included anyway.

= Tips =

==Example: Using a bitwise and operator==

Theory: You can check if a number is even {0, 2, 4, ...} or odd (1, 3, 5, ...) by testing the least significant binary digit of an integer (two's complement). If it's 0, this is an even number (0, 2, 4, ...). If it's 1, this is an odd number {1, 3, 5, ...}.

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 4; ++Index)
{
if ((Index & 1) == 0) // Test if the least significant bit is cleared.
{
Log ("["$Index$"] Even");
}

if ((Index & 1) == 1) // Test if the least significant bit is set.
{
Log ("["$Index$"] Odd");
}
}
}

// Output:
// ScriptLog: [0] Even
// ScriptLog: [1] Odd
// ScriptLog: [2] Even
// ScriptLog: [3] Odd</uscript>

==Example: Using a bitwise and operator II==

<uscript>function Example ()
{
local int Index;

for (Index = 0; Index < 8; ++Index)
{
if ((Index & 2) == 2) // Test if bit #2 is set.
{
Log ("["$Index$"] Set");
}
}
}

// Output:
// ScriptLog: [2] Set
// ScriptLog: [3] Set
// ScriptLog: [6] Set
// ScriptLog: [7] Set</uscript>

==Example: Using a bitwise or operator==

Theory: The color-coded text strings have the format 0x1B (ANSI Escape Code) followed by three bytes representing the red, green, and blue channels, where each channel must be in the range [1, 255] because the value 0 (NUL) terminates the string. The function in this example takes a color and uses the bitwise or operator to make sure that the value of each color channel is always at least 1. Note that there is no alpha channel (the string is opaque). Note that StrLen counts color codes.

<uscript>function string GetTextColorCoded (Color Color)
{
return
(
Chr (0x1B)
$ Chr (Color.R | 1)
$ Chr (Color.G | 1)
$ Chr (Color.B | 1)
);
}</uscript>

UE2:GameInfo properties (UT2004)

2012-04-26T11:12:43Z

Rejecht: /* TimeLimit */

{{infobox class part
| class = GameInfo
| part = properties
| parent1 = Info
| parent2 = Actor
| parent3 = Object
}}
{{autogenerated}}
==Properties==
===Property group 'GameInfo'===
====AccessControlClass====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' "Engine.AccessControl"

====Acronym====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache



'''Default value:''' "???"

====BroadcastClass====
'''Type:''' [[class]]<{{cl|BroadcastHandler}}>



====BroadcastHandlerClass====
'''Type:''' [[string]]



'''Default value:''' "Engine.BroadcastHandler"

====CurrentGameProfile====
'''Type:''' {{cl|GameProfile}}

'''[[Variables#Modifiers|Modifiers]]:''' transient



====DecoTextName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

deprecated ?

====Description====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache, localized



====GameName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache, localized



'''Default value:''' "Game"

====GameReplicationInfoClass====
'''Type:''' [[class]]<{{cl|GameReplicationInfo}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|GameReplicationInfo|Engine}}'

====ResetCountDown====
'''Type:''' [[int]]



====ResetTimeDelay====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

time (seconds) before restarting teams

====SaveGameManifest====
'''Type:''' {{cl|Manifest}}

'''[[Variables#Modifiers|Modifiers]]:''' private, const, transient



====ScreenShotName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache



====VoiceReplicationInfoClass====
'''Type:''' [[class]]<{{cl|VoiceChatReplicationInfo}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|VoiceChatReplicationInfo|Engine}}'

===Internal variables===
====AccessControl====
'''Type:''' {{cl|AccessControl}}

AccessControl controls whether players can enter and/or become admins

====AutoAim====
'''Type:''' [[float]]



'''Default value:''' 0.93

====bAdminCanPause====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====bAllowBehindView====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====bAllowMPGameSpeed====
'''Type:''' [[bool]]



====bAllowVehicles====
'''Type:''' [[bool]]

are vehicles allowed in this gametype?

====bAllowWeaponThrowing====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' config



'''Default value:''' True

====bAlreadyChanged====
'''Type:''' [[bool]]



====bAlternateMode====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' localized



====BaseMutator====
'''Type:''' {{cl|Mutator}}

linked list of Mutators (for modifying actors as they enter the game)

====bAttractCam====
'''Type:''' [[bool]]



====bCanChangeSkin====
'''Type:''' [[bool]]

Allow player to change skins in game.

'''Default value:''' True

====bCanViewOthers====
'''Type:''' [[bool]]



'''Default value:''' True

====bChangeLevels====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' True

====bDelayedStart====
'''Type:''' [[bool]]



'''Default value:''' True

====BeaconName====
'''Type:''' [[string]]

Identifying string used for finding LAN servers.

====bEnableStatLogging====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

If True, games will log

====bForceClassicView====
'''Type:''' [[bool]]

OBSOLETE

====bGameEnded====
'''Type:''' [[bool]]

set when game ends

====bGameRestarted====
'''Type:''' [[bool]]



====BindColor====
'''Type:''' {{tl|Color|Object|structs}}



'''Default value:'''
{| class="list defaults"
! {{tl|Color||Object structs|Member}}
! Value
|-
| A
| 255
|-
| G
| 128
|-
| R
| 128
|}

====bIsSaveGame====
'''Type:''' [[bool]]

stays true during entire game (unlike LevelInfo property)

====bLargeGameVOIP====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====bLiberalVehiclePaths====
'''Type:''' [[bool]]



====bLoggingGame====
'''Type:''' [[bool]]

Does this gametype log?

====bLowGore====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

OBSOLETE - use GoreLevel instead;

====bModViewShake====
'''Type:''' [[bool]]

for mutators to turn off weaponviewshake

'''Default value:''' True

====bMustJoinBeforeStart====
'''Type:''' [[bool]]

players can only spectate if they join after the game starts

====BotMenuType====
'''Type:''' [[string]]

Type of bot menu to display. -NOT USED-

====bOverTime====
'''Type:''' [[bool]]



====bPauseable====
'''Type:''' [[bool]]

Whether the game is pauseable.

'''Default value:''' True

====bRestartLevel====
'''Type:''' [[bool]]

Level should be restarted when player dies

'''Default value:''' True

====BroadcastHandler====
'''Type:''' {{cl|BroadcastHandler}}

handles message (text and localized) broadcasts

====bTeamGame====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

This is a team game.

====bTestMode====
'''Type:''' [[bool]]



====bWaitingToStartMatch====
'''Type:''' [[bool]]



====bWeaponShouldViewShake====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' True

====bWeaponStay====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' config

Whether or not weapons stay when picked up.

====bWelcomePending====
'''Type:''' [[bool]]



====CallSigns====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 15



'''Default value, index 0:''' "ALPHA"

'''Default value, index 10:''' "KILO"

'''Default value, index 11:''' "LIMA"

'''Default value, index 12:''' "MIKE"

'''Default value, index 13:''' "NOVEMBER"

'''Default value, index 14:''' "OSCAR"

'''Default value, index 15:''' "BRAVO"

'''Default value, index 16:''' "CHARLIE"

'''Default value, index 17:''' "DELTA"

'''Default value, index 18:''' "ECHO"

'''Default value, index 19:''' "FOXTROT"

'''Default value, index 20:''' "GOLF"

'''Default value, index 21:''' "HOTEL"

'''Default value, index 22:''' "INDIA"

'''Default value, index 23:''' "JULIET"

====CurrentID====
'''Type:''' [[int]]



'''Default value:''' 1

====DeathMessageClass====
'''Type:''' [[class]]<{{cl|LocalMessage}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|LocalMessage|Engine}}'

====DefaultPlayerClassName====
'''Type:''' [[string]]



====DefaultPlayerName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value:''' "Player"

====DemoCommand====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' transient



====FearCostFallOff====
'''Type:''' [[float]]

how fast the FearCost in NavigationPoints falls off

'''Default value:''' 0.95

====GameDifficulty====
'''Type:''' [[float]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' 1.0

====GameMessageClass====
'''Type:''' [[class]]<{{cl|GameMessage}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|GameMessage|Engine}}'

====GameOptionsMenuType====
'''Type:''' [[string]]

Type of options dropdown to display. -NOT USED-

====GameReplicationInfo====
'''Type:''' {{cl|GameReplicationInfo}}



====GameRulesModifiers====
'''Type:''' {{cl|GameRules}}

linked list of modifier classes which affect game rules

====GameSpeed====
'''Type:''' [[float]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

Scale applied to game rate.

'''Default value:''' 1.0

====GameStats====
'''Type:''' {{cl|GameStats}}

Holds the GameStats actor

====GameStatsClass====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====GameUMenuType====
'''Type:''' [[string]]

Type of Game dropdown to display. (Used as map menu in Onslaught)

====GIPropDescText====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 15 (<code>{{tl|GIPROPNUM||GameInfo}}</code>)

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value, index 0:''' "Set the skill of your bot opponents."

'''Default value, index 1:''' "When enabled, weapons will always be available for pickup."

'''Default value, index 10:''' "When enabled, players can throw their current weapon out."

'''Default value, index 11:''' "Controls whether players can switch to a third person view."

'''Default value, index 12:''' "Controls whether administrators can pause the game."

'''Default value, index 13:''' "Specifies how long to wait before kicking idle player from server."

'''Default value, index 14:''' "When enabled, some weapons cause view shaking while firing."

'''Default value, index 15:''' "Enable this option to reduce the amount of blood and guts you see."

'''Default value, index 16:''' "Controls how fast time passes in the game."

'''Default value, index 17:''' "Sets the maximum number of spectators that can watch the game."

'''Default value, index 18:''' "Sets the maximum number of players that can join this server."

'''Default value, index 19:''' "The game ends when someone reaches this score."

'''Default value, index 20:''' "Limits how many times players can respawn after dying."

'''Default value, index 21:''' "The game ends after this many minutes of play."

'''Default value, index 22:''' "Enable this option to send game statistics to the UT2004 global stats server"

====GIPropsDisplayText====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 15 (<code>{{tl|GIPROPNUM||GameInfo}}</code>)

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value, index 0:''' "Bot Skill"

'''Default value, index 1:''' "Weapons Stay"

'''Default value, index 10:''' "Allow Weapon Throwing"

'''Default value, index 11:''' "Allow Behind View"

'''Default value, index 12:''' "Allow Admin Pausing"

'''Default value, index 13:''' "Kick Idlers Time"

'''Default value, index 14:''' "Weapons shake view"

'''Default value, index 15:''' "Reduce Gore Level"

'''Default value, index 16:''' "Game Speed"

'''Default value, index 17:''' "Max Spectators"

'''Default value, index 18:''' "Max Players"

'''Default value, index 19:''' "Goal Score"

'''Default value, index 20:''' "Max Lives"

'''Default value, index 21:''' "Time Limit"

'''Default value, index 22:''' "World Stats Logging"

====GIPropsExtras====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 2

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value:''' "0.000000;Novice;1.000000;Average;2.000000;Experienced;3.000000;Skilled;4.000000;Adept;5.000000;Masterful;6.000000;Inhuman;7.000000;Godlike"

====GoalScore====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

what score is needed to end the match

====GoreLevel====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' 2

====GoreLevelText====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 3

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value, index 0:''' "No Gore"

'''Default value, index 1:''' "Reduced Gore"

'''Default value, index 2:''' "Full Gore"

====HUDSettingsMenu====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Optional GUI page for configuring HUD options specific to this gametype

====HUDType====
'''Type:''' [[string]]

HUD class this game uses.

'''Default value:''' "Engine.HUD"

====MaplistHandler====
'''Type:''' {{cl|MaplistManagerBase}}

'''[[Variables#Modifiers|Modifiers]]:''' transient



====MaplistHandlerClass====
'''Type:''' [[class]]<{{cl|MaplistManagerBase}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|MaplistManager|Engine}}'

====MaplistHandlerType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====MapListType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Maplist this game uses.

====MapPrefix====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Prefix characters for names of maps for this game type.

====MaxIdleTime====
'''Type:''' [[float]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====MaxLives====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

max number of lives for match, unless overruled by level's GameDetails

====MaxPlayers====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' 16

====MaxSpectators====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

Maximum number of spectators.

'''Default value:''' 2

====MultiplayerUMenuType====
'''Type:''' [[string]]

Type of Multiplayer dropdown to display. -NOT USED-

====MutatorClass====
'''Type:''' [[string]]



'''Default value:''' "Engine.Mutator"

====NoBindString====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value:''' "[None]"

====NumBots====
'''Type:''' [[int]]

number of non-human players (AI controlled but participating as a player)

====NumPlayers====
'''Type:''' [[int]]

number of human players

====NumSpectators====
'''Type:''' [[int]]

Current number of spectators.

====OtherMesgGroup====
'''Type:''' [[name]]



====PlayerControllerClass====
'''Type:''' [[class]]<{{cl|PlayerController}}>

type of player controller to spawn for players logging in

====PlayerControllerClassName====
'''Type:''' [[string]]



'''Default value:''' "Engine.PlayerController"

====RulesMenuType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Type of rules menu to display.

====ScoreBoardType====
'''Type:''' [[string]]

Type of class<Menu> to use for scoreboards. (gam)

====SecurityClass====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====ServerSkillLevel====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

The Server Skill Level ( 0 - 2, Beginner - Advanced )

====SettingsMenuType====
'''Type:''' [[string]]

Type of settings menu to display. -NOT USED-

====StartTime====
'''Type:''' [[float]]



====TimeLimit====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

TimeLimit has three contexts.

# (TimeLimit < 0) -> TimeLimit behaviour is not defined.
# (TimeLimit == 0) -> TimeLimit is not enforced and thus RemainingTime is never decremented and thus TimeLimit is not an end-game criteria.
# (TimeLimit > 0) -> TimeLimit represents the number of minutes [1, 999] and is used to initialize RemainingTime (seconds) which is then decremented every second.

TimeLimit is affected by:
* (DefaultMaxLives > 0) -> TimeLimit = 0
* ((GoalScore == 0) && (TimeLimit == 0)) -> TimeLimit = 20 -- See the DeathMatch.CheckReady function.

TimeLimit affects:
* (TimeLimit > 0) --> --RemainingTime

TimeLimit triggers:
* EndGame ("TimeLimit")

====VehicleList====
'''Type:''' {{cl|Vehicle}}



====VoiceReplicationInfo====
'''Type:''' {{cl|VoiceChatReplicationInfo}}



====VotingHandler====
'''Type:''' {{cl|VotingHandler}}

'''[[Variables#Modifiers|Modifiers]]:''' transient



====VotingHandlerClass====
'''Type:''' [[class]]<{{cl|VotingHandler}}>



====VotingHandlerType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' "xVoting.xVotingHandler"

UE2:GameInfo properties (UT2004)

2012-04-26T11:05:58Z

Rejecht: /* TimeLimit */

{{infobox class part
| class = GameInfo
| part = properties
| parent1 = Info
| parent2 = Actor
| parent3 = Object
}}
{{autogenerated}}
==Properties==
===Property group 'GameInfo'===
====AccessControlClass====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' "Engine.AccessControl"

====Acronym====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache



'''Default value:''' "???"

====BroadcastClass====
'''Type:''' [[class]]<{{cl|BroadcastHandler}}>



====BroadcastHandlerClass====
'''Type:''' [[string]]



'''Default value:''' "Engine.BroadcastHandler"

====CurrentGameProfile====
'''Type:''' {{cl|GameProfile}}

'''[[Variables#Modifiers|Modifiers]]:''' transient



====DecoTextName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

deprecated ?

====Description====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache, localized



====GameName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache, localized



'''Default value:''' "Game"

====GameReplicationInfoClass====
'''Type:''' [[class]]<{{cl|GameReplicationInfo}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|GameReplicationInfo|Engine}}'

====ResetCountDown====
'''Type:''' [[int]]



====ResetTimeDelay====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

time (seconds) before restarting teams

====SaveGameManifest====
'''Type:''' {{cl|Manifest}}

'''[[Variables#Modifiers|Modifiers]]:''' private, const, transient



====ScreenShotName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache



====VoiceReplicationInfoClass====
'''Type:''' [[class]]<{{cl|VoiceChatReplicationInfo}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|VoiceChatReplicationInfo|Engine}}'

===Internal variables===
====AccessControl====
'''Type:''' {{cl|AccessControl}}

AccessControl controls whether players can enter and/or become admins

====AutoAim====
'''Type:''' [[float]]



'''Default value:''' 0.93

====bAdminCanPause====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====bAllowBehindView====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====bAllowMPGameSpeed====
'''Type:''' [[bool]]



====bAllowVehicles====
'''Type:''' [[bool]]

are vehicles allowed in this gametype?

====bAllowWeaponThrowing====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' config



'''Default value:''' True

====bAlreadyChanged====
'''Type:''' [[bool]]



====bAlternateMode====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' localized



====BaseMutator====
'''Type:''' {{cl|Mutator}}

linked list of Mutators (for modifying actors as they enter the game)

====bAttractCam====
'''Type:''' [[bool]]



====bCanChangeSkin====
'''Type:''' [[bool]]

Allow player to change skins in game.

'''Default value:''' True

====bCanViewOthers====
'''Type:''' [[bool]]



'''Default value:''' True

====bChangeLevels====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' True

====bDelayedStart====
'''Type:''' [[bool]]



'''Default value:''' True

====BeaconName====
'''Type:''' [[string]]

Identifying string used for finding LAN servers.

====bEnableStatLogging====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

If True, games will log

====bForceClassicView====
'''Type:''' [[bool]]

OBSOLETE

====bGameEnded====
'''Type:''' [[bool]]

set when game ends

====bGameRestarted====
'''Type:''' [[bool]]



====BindColor====
'''Type:''' {{tl|Color|Object|structs}}



'''Default value:'''
{| class="list defaults"
! {{tl|Color||Object structs|Member}}
! Value
|-
| A
| 255
|-
| G
| 128
|-
| R
| 128
|}

====bIsSaveGame====
'''Type:''' [[bool]]

stays true during entire game (unlike LevelInfo property)

====bLargeGameVOIP====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====bLiberalVehiclePaths====
'''Type:''' [[bool]]



====bLoggingGame====
'''Type:''' [[bool]]

Does this gametype log?

====bLowGore====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

OBSOLETE - use GoreLevel instead;

====bModViewShake====
'''Type:''' [[bool]]

for mutators to turn off weaponviewshake

'''Default value:''' True

====bMustJoinBeforeStart====
'''Type:''' [[bool]]

players can only spectate if they join after the game starts

====BotMenuType====
'''Type:''' [[string]]

Type of bot menu to display. -NOT USED-

====bOverTime====
'''Type:''' [[bool]]



====bPauseable====
'''Type:''' [[bool]]

Whether the game is pauseable.

'''Default value:''' True

====bRestartLevel====
'''Type:''' [[bool]]

Level should be restarted when player dies

'''Default value:''' True

====BroadcastHandler====
'''Type:''' {{cl|BroadcastHandler}}

handles message (text and localized) broadcasts

====bTeamGame====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

This is a team game.

====bTestMode====
'''Type:''' [[bool]]



====bWaitingToStartMatch====
'''Type:''' [[bool]]



====bWeaponShouldViewShake====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' True

====bWeaponStay====
'''Type:''' [[bool]]

'''[[Variables#Modifiers|Modifiers]]:''' config

Whether or not weapons stay when picked up.

====bWelcomePending====
'''Type:''' [[bool]]



====CallSigns====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 15



'''Default value, index 0:''' "ALPHA"

'''Default value, index 10:''' "KILO"

'''Default value, index 11:''' "LIMA"

'''Default value, index 12:''' "MIKE"

'''Default value, index 13:''' "NOVEMBER"

'''Default value, index 14:''' "OSCAR"

'''Default value, index 15:''' "BRAVO"

'''Default value, index 16:''' "CHARLIE"

'''Default value, index 17:''' "DELTA"

'''Default value, index 18:''' "ECHO"

'''Default value, index 19:''' "FOXTROT"

'''Default value, index 20:''' "GOLF"

'''Default value, index 21:''' "HOTEL"

'''Default value, index 22:''' "INDIA"

'''Default value, index 23:''' "JULIET"

====CurrentID====
'''Type:''' [[int]]



'''Default value:''' 1

====DeathMessageClass====
'''Type:''' [[class]]<{{cl|LocalMessage}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|LocalMessage|Engine}}'

====DefaultPlayerClassName====
'''Type:''' [[string]]



====DefaultPlayerName====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value:''' "Player"

====DemoCommand====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' transient



====FearCostFallOff====
'''Type:''' [[float]]

how fast the FearCost in NavigationPoints falls off

'''Default value:''' 0.95

====GameDifficulty====
'''Type:''' [[float]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' 1.0

====GameMessageClass====
'''Type:''' [[class]]<{{cl|GameMessage}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|GameMessage|Engine}}'

====GameOptionsMenuType====
'''Type:''' [[string]]

Type of options dropdown to display. -NOT USED-

====GameReplicationInfo====
'''Type:''' {{cl|GameReplicationInfo}}



====GameRulesModifiers====
'''Type:''' {{cl|GameRules}}

linked list of modifier classes which affect game rules

====GameSpeed====
'''Type:''' [[float]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

Scale applied to game rate.

'''Default value:''' 1.0

====GameStats====
'''Type:''' {{cl|GameStats}}

Holds the GameStats actor

====GameStatsClass====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====GameUMenuType====
'''Type:''' [[string]]

Type of Game dropdown to display. (Used as map menu in Onslaught)

====GIPropDescText====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 15 (<code>{{tl|GIPROPNUM||GameInfo}}</code>)

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value, index 0:''' "Set the skill of your bot opponents."

'''Default value, index 1:''' "When enabled, weapons will always be available for pickup."

'''Default value, index 10:''' "When enabled, players can throw their current weapon out."

'''Default value, index 11:''' "Controls whether players can switch to a third person view."

'''Default value, index 12:''' "Controls whether administrators can pause the game."

'''Default value, index 13:''' "Specifies how long to wait before kicking idle player from server."

'''Default value, index 14:''' "When enabled, some weapons cause view shaking while firing."

'''Default value, index 15:''' "Enable this option to reduce the amount of blood and guts you see."

'''Default value, index 16:''' "Controls how fast time passes in the game."

'''Default value, index 17:''' "Sets the maximum number of spectators that can watch the game."

'''Default value, index 18:''' "Sets the maximum number of players that can join this server."

'''Default value, index 19:''' "The game ends when someone reaches this score."

'''Default value, index 20:''' "Limits how many times players can respawn after dying."

'''Default value, index 21:''' "The game ends after this many minutes of play."

'''Default value, index 22:''' "Enable this option to send game statistics to the UT2004 global stats server"

====GIPropsDisplayText====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 15 (<code>{{tl|GIPROPNUM||GameInfo}}</code>)

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value, index 0:''' "Bot Skill"

'''Default value, index 1:''' "Weapons Stay"

'''Default value, index 10:''' "Allow Weapon Throwing"

'''Default value, index 11:''' "Allow Behind View"

'''Default value, index 12:''' "Allow Admin Pausing"

'''Default value, index 13:''' "Kick Idlers Time"

'''Default value, index 14:''' "Weapons shake view"

'''Default value, index 15:''' "Reduce Gore Level"

'''Default value, index 16:''' "Game Speed"

'''Default value, index 17:''' "Max Spectators"

'''Default value, index 18:''' "Max Players"

'''Default value, index 19:''' "Goal Score"

'''Default value, index 20:''' "Max Lives"

'''Default value, index 21:''' "Time Limit"

'''Default value, index 22:''' "World Stats Logging"

====GIPropsExtras====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 2

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value:''' "0.000000;Novice;1.000000;Average;2.000000;Experienced;3.000000;Skilled;4.000000;Adept;5.000000;Masterful;6.000000;Inhuman;7.000000;Godlike"

====GoalScore====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

what score is needed to end the match

====GoreLevel====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' 2

====GoreLevelText====
'''Type:''' [[string]]

'''[[Static arrays|Array size]]:''' 3

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value, index 0:''' "No Gore"

'''Default value, index 1:''' "Reduced Gore"

'''Default value, index 2:''' "Full Gore"

====HUDSettingsMenu====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Optional GUI page for configuring HUD options specific to this gametype

====HUDType====
'''Type:''' [[string]]

HUD class this game uses.

'''Default value:''' "Engine.HUD"

====MaplistHandler====
'''Type:''' {{cl|MaplistManagerBase}}

'''[[Variables#Modifiers|Modifiers]]:''' transient



====MaplistHandlerClass====
'''Type:''' [[class]]<{{cl|MaplistManagerBase}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|MaplistManager|Engine}}'

====MaplistHandlerType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====MapListType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Maplist this game uses.

====MapPrefix====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Prefix characters for names of maps for this game type.

====MaxIdleTime====
'''Type:''' [[float]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====MaxLives====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

max number of lives for match, unless overruled by level's GameDetails

====MaxPlayers====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' 16

====MaxSpectators====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

Maximum number of spectators.

'''Default value:''' 2

====MultiplayerUMenuType====
'''Type:''' [[string]]

Type of Multiplayer dropdown to display. -NOT USED-

====MutatorClass====
'''Type:''' [[string]]



'''Default value:''' "Engine.Mutator"

====NoBindString====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' localized



'''Default value:''' "[None]"

====NumBots====
'''Type:''' [[int]]

number of non-human players (AI controlled but participating as a player)

====NumPlayers====
'''Type:''' [[int]]

number of human players

====NumSpectators====
'''Type:''' [[int]]

Current number of spectators.

====OtherMesgGroup====
'''Type:''' [[name]]



====PlayerControllerClass====
'''Type:''' [[class]]<{{cl|PlayerController}}>

type of player controller to spawn for players logging in

====PlayerControllerClassName====
'''Type:''' [[string]]



'''Default value:''' "Engine.PlayerController"

====RulesMenuType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' cache

Type of rules menu to display.

====ScoreBoardType====
'''Type:''' [[string]]

Type of class<Menu> to use for scoreboards. (gam)

====SecurityClass====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



====ServerSkillLevel====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig

The Server Skill Level ( 0 - 2, Beginner - Advanced )

====SettingsMenuType====
'''Type:''' [[string]]

Type of settings menu to display. -NOT USED-

====StartTime====
'''Type:''' [[float]]



====TimeLimit====
'''Type:''' [[int]]

'''[[Variables#Modifiers|Modifiers]]:''' config

TimeLimit has three contexts.

# (TimeLimit < 0) -> TimeLimit behaviour is not defined.
# (TimeLimit == 0) -> TimeLimit is not enforced and thus RemainingTime is never decremented and thus TimeLimit is not an end-game criteria.
# (TimeLimit > 0) -> TimeLimit represents the number of minutes [1, 999] and is used to initialize RemainingTime (seconds) which is then decremented every second.

TimeLimit is affected by:
* (DefaultMaxLives > 0) -> TimeLimit = 0
* ((GoalScore == 0) && (TimeLimit == 0)) -> TimeLimit = 20 -- See the DeathMatch.CheckReady function.

TimeLimit affects:
* (TimeLimit > 0) --> --RemainingTime

TimeLimit triggers:
* CheckEndGame ("TimeLimit")

====VehicleList====
'''Type:''' {{cl|Vehicle}}



====VoiceReplicationInfo====
'''Type:''' {{cl|VoiceChatReplicationInfo}}



====VotingHandler====
'''Type:''' {{cl|VotingHandler}}

'''[[Variables#Modifiers|Modifiers]]:''' transient



====VotingHandlerClass====
'''Type:''' [[class]]<{{cl|VotingHandler}}>



====VotingHandlerType====
'''Type:''' [[string]]

'''[[Variables#Modifiers|Modifiers]]:''' globalconfig



'''Default value:''' "xVoting.xVotingHandler"

User:Rejecht

2012-03-15T18:11:41Z

Rejecht: /* InitTeamSymbols may sometimes give both teams the same team symbol */

User:Rejecht

2012-03-08T22:22:12Z

Rejecht: /* PlayTakeHit never played drowning sound */

User:Rejecht

2012-03-08T22:07:02Z

Rejecht: /* Where */

User:Rejecht

2012-03-08T22:06:23Z

Rejecht: /* Where */

User:Rejecht

2012-03-08T21:59:50Z

Rejecht: /* About */

== About ==

Haphazard hobbyist programming sessions.

=== Where ===

* rejecht on the [http://forums.beyondunreal.com/member.php?u=59753 Beyond Unreal Forums]
* rejecht on the [http://forums.epicgames.com/members/1358276-rejecht Epic Games Forums]
* rejecht on [https://sites.google.com/site/rejecht/ Google Sites - rejecht's notes]
** rejecht's notes is poorly maintained. It is what it is.
* rejecht on [http://ut2004.titaninternet.co.uk/forums/member.php?u=1901 Titan Onslaught Forums]
* rejecht on [https://twitter.com/#!/rejecht Twitter]

== Experience ==

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Unreal Tournament 2004 Bugs || Errors ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly. This is by design, but not necessarily desirable.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before calling ScoreKill, since the DeathMatch implementation expects (NumLives >= MaxLives) and sets bOutofLives accordingly.

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Bad: Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Bad: Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

The best solution is to track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this behavior, in case someone actually wants the default behavior.

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

''(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)
''

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution is simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Group_Text_TeamSymbol.Length - 1);
Index_TeamSymbol[1] = Rand (Group_Text_TeamSymbol.Length - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Triggers:
* Pawn is in a water volume and the match has entered the MatchOver state.

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn.

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a class object (Class<DamageType> Class_DamageType).
* Use IsA with an instance of a class object.

Trivia:
* I don't think the actual drowning sounds were included anyway.

=== (...) more to come. ===

User:Rejecht

2012-03-05T12:48:22Z

Rejecht: /* InitTeamSymbols may sometimes give both teams the same team symbol */

== About ==

Haphazard hobbyist programming sessions.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Game mechanical errors discovered in Unreal Tournament 2004 ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before or after calling ScoreKill, since it expects (NumLives >= MaxLives).

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Best: Track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this, in case someone actually wants the default behavior.
# Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution was simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

('''Index_MaxTeams''' == 2)

The (Count_TeamSymbols < 10) check is an early warning system for someone who managed to change the team symbols--this implementation is adapted for at least ten different team symbols.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Group_Text_TeamSymbol.Length - 1);
Index_TeamSymbol[1] = Rand (Group_Text_TeamSymbol.Length - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn .

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a class object (Class<DamageType> Class_DamageType).
* Use IsA with an instance of a class object.

(...) more to come.

User:Rejecht

2012-03-05T12:46:00Z

Rejecht: /* Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again */

== About ==

Haphazard hobbyist programming sessions.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Game mechanical errors discovered in Unreal Tournament 2004 ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before or after calling ScoreKill, since it expects (NumLives >= MaxLives).

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Best: Track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this, in case someone actually wants the default behavior.
# Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

(First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing. This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.)

So, sometimes, when a player presses the Fire button, just right after a controller enters one of the Player* states (PlayerWalking), ServerSpectate gets called, which destroys the pawn, enters a spectating state, and then ignores ClientRestart calls.

The first solution was simply to ignore ServerSpectate in the Player* states in PlayerController; such as PlayerWaiting, PlayerWalking, WaitingforPawn.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Group_Text_TeamSymbol.Length - 1);
Index_TeamSymbol[1] = Rand (Group_Text_TeamSymbol.Length - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn .

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a class object (Class<DamageType> Class_DamageType).
* Use IsA with an instance of a class object.

(...) more to come.

User:Rejecht

2012-03-05T12:41:26Z

Rejecht: /* Players who are out can sometimes respawn */

== About ==

Haphazard hobbyist programming sessions.

=== Nice to know ===

==== NumLives is not the number of lives ====
NumLives is the number of deaths (the number of lives used).

==== Errors found in Unreal Engine 2.5 may also be present in the UDK ====

=== Game mechanical errors discovered in Unreal Tournament 2004 ===

==== Players who are out can sometimes respawn ====

Triggers for this error:
* It must be a TeamGame.
* (MaxLives > 0) - Assume that this example has (MaxLives == 1)
* TeamGame.ScoreKill has the errors.

By design?
* Team kills are not counted as deaths, thus giving the player another chance. This might be desirable in some game types, however, a simple solution is to track the NumLives of the killed player before and after the TeamGame.ScoreKill call; if NumLives is unchanged, decide whether to call Super(DeathMatch).ScoreKill to deal with this, depending on whether this behavior is wanted.

Consequences:
* The player can respawn despite having died the allotted MaxLives.

Cause:
* The ScoreKill logic in TeamGame does not always call Super.ScoreKill, which is the one handling the NumLives count and sets bOutofLives accordingly.

First attempt:
* OK, so let's just override ScoreKill and increment NumLives ourselves, before or after calling ScoreKill, since it expects (NumLives >= MaxLives).

First consequence of the first attempt:
While this solved the original problem, it also introduced another problem:
* This triggers LateEntryLives (which defaults to 1), forcing latecomers to become spectators (bOnlySpectator) at login, and some people losing their hair because they now have a new unwanted behaviour.
This is because some players now get (NumLives == 2), and others get (NumLives == 1), depending on the circumstances in TeamGame.ScoreKill. Login checks LateEntryLives against all players and boots the player to a spectator slot when it finds (NumLives (2) > LateEntryLives (1)).

Other possible approaches to solve the first consequence:
# Best: Track changes in NumLives and act accordingly after a Super.ScoreKill call to the TeamGame implementation. Also, add a choice whether to trigger this, in case someone actually wants the default behavior.
# Set LateEntryLives to MAXINT in InitGame to override any ini setting, unless you want to use LateEntryLives.
# Preincrement NumLives before Super.ScoreKill and clamp the value postcall (the first attempt).

==== AskforPawn and ClientGotoState ====

AskforPawn insists on calling ClientGotoState ('Spectating', 'Begin'), but there is no Begin: label in the Spectating state, which leads to an error.

The UDK solves this in the ClientGotoState function, but this code base also gets rid of the logic forcing the client to a spectating state.

==== Sometimes a player pawn spawns and gets possessed, but immediately gets destroyed again ====

First, figuring out how to reproduce the error took some time, then the technique to trigger it again during testing.
This one took 3/4 of a day to figure out and solve; logging/tracing client-side and server-side state changes step by effing step.

So, sometimes, when a player presses the Fire button, right after a controller enters one of the Player* states, ServerSpectate gets called, which destroys the pawn, enters a spectating state, which ignores ClientRestart calls.

The first solution was simply to ignore ServerSpectate in states such as Player* states in PlayerController; PlayerWaiting, PlayerWalking, etc.

==== InitTeamSymbols may sometimes give both teams the same team symbol ====

DeathMatch.InitTeamSymbols is replaced with the following implementation.

Instead of getting in trouble with more random numbers, it just picks the next team symbol in the array, wrapping around to zero.

<uscript>
// *UT2004Fix*
// (Replaces) DeathMatch.InitTeamSymbols
// - Sometimes both teams would get the same team symbol.

event InitTeamSymbols ()
{
local array<string> Group_Text_TeamSymbol;
local int Count_TeamSymbols;
local int Index_TeamSymbol[Index_MaxTeams];
local Texture Texture_TeamSymbol;

// ** Attempt to get a list of team symbols.

if
(
(GameReplicationInfo.TeamSymbols[0] != None)
&&
(GameReplicationInfo.TeamSymbols[1] != None)
)
{
return; // Already loaded.
}

// ** Team Symbol Names

Class'CacheManager'.Static.GetTeamSymbolList (Group_Text_TeamSymbol, true);

Count_TeamSymbols = Group_Text_TeamSymbol.Length;

if (Count_TeamSymbols < 10)
{
Warn ("(Count_TeamSymbols < 10)");

return;
}

// ** Randomization

Index_TeamSymbol[0] = Rand (Group_Text_TeamSymbol.Length - 1);
Index_TeamSymbol[1] = Rand (Group_Text_TeamSymbol.Length - 9);

// **
// - Handle Equality

if (Index_TeamSymbol[0] == Index_TeamSymbol[1])
{
++Index_TeamSymbol[1];

if (Index_TeamSymbol[1] >= Count_TeamSymbols)
{
Index_TeamSymbol[1] = 0;
}
}

// ** Red Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[0]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[0] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[0] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[0]]);
}

// ** Blue Team

Texture_TeamSymbol = Texture(DynamicLoadObject (Group_Text_TeamSymbol[Index_TeamSymbol[1]], Class'Texture'));

if (Texture_TeamSymbol != None)
{
GameReplicationInfo.TeamSymbols[1] = Texture_TeamSymbol;
}
else
{
Warn ("(Texture_TeamSymbol[1] == None)"@Group_Text_TeamSymbol[Index_TeamSymbol[1]]);
}

// ** Replication

GameReplicationInfo.TeamSymbolNotify ();
}

</uscript>

==== ToggleScreenShotMode does not restore a variety of state ====

Scope:
* PlayerController.ToggleScreenShotMode

Type:
* Save/Restore

Fix:
# Remember and restore Handedness, bHideVehicleNoEntryIndicator.

==== TakeDrowningDamage ====

Scope:
* Pawn.TakeDrowningDamage

Type:
* Access Error

Fix:
# Check (Controller != None) before calling Super.TakeDrowningDamage in a subclass of pawn .

==== PlayTakeHit never played drowning sound ====

Scope:
* xPawn.PlayTakeHit

Type:
* Class Check Error

Corrections:
# Find: DamageType.IsA('Drowned')
# Replace With: DamageType == Class'Drowned'

Reminder:
* Do not use IsA with a class object (Class<DamageType> Class_DamageType).
* Use IsA with an instance of a class object.

(...) more to come.