Unreal Wiki - User contributions [en]

Compiler errors overview

2012-11-16T10:14:29Z

Crusha: /* Functions */ Error, Code space for FUNCTION overflowed by n bytes :

{{expand}}

__NOTOC__
{|style="width:100%;"
|-valign="top"
|
==Preprocessor errors==
{{main|preprocessor errors}}
A description and solution to [[preprocessor]] errors.
|
==Subobjects errors==
{{main|subobject errors}}
A description and solution to [[subobjects]] errors.
|
==Interface errors==
{{main|interface errors}}
A description and solution to [[interface]] errors.
|}

==Other errors==
{{Compiler error|id=0001|error=Could not load existing package file 'package path'|desc=}}

{{Compiler error|id=0002|error='[[ForEach]]'<nowiki>:</nowiki> An iterator expression is required|desc=After the ForEach keyword a standard function call to an [[iterator]] function is required. That iterator function could be called in the context of the current code (e.g. "foreach AllActors(...)") or within the context of some other object (e.g. "foreach WorldInfo.AllPawns(...)" calls the AllPawns iterator of the WorldInfo)}}

{{Compiler error|id=0003|error=Operator '!='<nowiki>:</nowiki> Comparison will always succeed|desc=You probably already ensured that the values you are trying to compare are really different. In that case it would be pointless to perform exactly the same comparison again}}

{{Compiler error|id=0004|error=[[NameOf]] argument is not an identifier|desc=}}

{{Compiler error|id=0005|error=Illegal character in name|desc=}}

{{Compiler error|id=0006|error=Left type is incompatible with '[[Operator|OPERATERNAME]]'|desc=}}

===Classes===
;Error, 'class'<nowiki>:</nowiki> Limitor 'class name' is not a class name :

;Error, Classes with [[config]]/[[globalconfig]] member variables need to specify config file. : You used a ''config'' modifier on a variable but forgot to add the class modifier ''config'' (resulting in the default INI file for your application) or ''config(*name of the INI*)''.

;Error, Class '[[localized]]' keyword is no longer required : Self explanatory. The localized modifier was only necessary in early {{UE1}} games, in newer generations this is automatic implied.

;Error, failed to find [[DependsOn]]/[[Implements]] class '[[Class]]' while parsing '[[Class]]' : Self explanatory. However it could be that you have made a typo or that you are referencing a [[struct]] rather than a [[class]].

;Error, Script vs. class name mismatch (ClassName/FileName) : The name in the header of your class doesn't match the name of the UC file.

===Variables===
;Error, Instance variables are only allowed at class scope (use 'local'?) : [[Variables]] are declared using the keyword '''local''' inside functions. Variables cannot be declared at [[state]] scope.

;Error, Not allowed to use '[[Variable#Modifiers_affecting_values|config]]' with object variables : Object variables cannot be made configurable. If you want to store a configurable class, material, sound, etc., consider storing it in a configurable string variable instead and using [[DynamicLoadObject]]() at runtime to load the configured object.

;Error, Can't assign Const variables :

;Error, Variable declaration<nowiki>:</nowiki> 'idx' already defined : trying to declare a local variable when one is defined as a function parameter. (Parameters are also local variables!)

;Error, '[[RepRetry]]' is only allowed on struct properties :

===States===
;Error, '[[state]]'<nowiki>:</nowiki> expecting State, got Function : This was caused by calling a state '''sleep''' where sleep is a function of state. Im guessing any function previously defined can conflict with a state.

;Error, '[[Ignores]]'<nowiki>:</nowiki> 'Function Name' is not a function : The Ignores statement only accepts existing functions. In other words, if you created the function within the state (instead of ignoring it), you would be able to call [[Super]].FunctionName(...) in it.

===Functions===
;Error, Calling a [[singular]] function within a singular function on the same object will always fail : A function with the ''singular'' modifier will only execute if the same object is not already executing another singular function, thus the compiler rejects direct calls to other singular functions.

;Error, Bad function definition : This happens when you define a function with an object as the return but that object does not exist.

;Error, Code space for [[function|FUNCTIONNAME]] overflowed by n bytes : There is a hard limit on the number of local variable allocations you can do per function call. When this error occurs, you stepped over that limit. You can fix it by moving some functionality and allocations to sub-function calls, but you should maybe start to question your code if you need that many allocations.

===Arrays===
;Error, Static arrays of dynamic arrays are not allowed : A variable has been declared with array<''type''> AND ''variablename''[n] at the same time.

;Error, Invalid property or function call on a dynamic array : You might have omitted an array index expression in square brackets after the array reference. If not, see [[dynamic arrays]] for a list of (pseudo) functions and properties you can use on dynamic arrays themselves.

===Typecasting===
;Error, Cast from 'object name' to 'object name' is unnecessary :

;Error, Cast from '[[class]]' to '[[class]]' will always fail : [[Typecasting]] from one class to another is only allowed to narrow a reference of one type to a subclass of that type. Casting to a class that is not a subclass of the current type would always return None and thus is rejected by the compiler.

===Unrecognized===
;Error, Unrecognized [[type]] 'class name' :

;Error, Unrecognized member 'variable name' in class 'class name' : The variable does not exist in this class.

===Unknown===
;Error, Unknown member '[[variable]]' in struct '[[struct]]' : The variable is not declared. Check if you have forgot to declare it or if you have made a typo.

;Error, Unknown Function 'function name' in 'Class package.class' :

===Unexpected===
;Error, Unexpected '[[defaultproperties]]' : This seems to occur when you have an end of multi-comment preceded by a line comment on the same line. See [[Compiler issues]]. Keep in mind that you can not specify default properties in code while using the UnrealEd internal script editor. Doing so will give you this error as well. To change the default properties of a class in UnrealEd, you need to type '''editdefault class=''classname''''' in the command line of the editor.
{{CorrectWrong|<uscript>/* The quick brown fox jumps over the lazy dog */
// ...</uscript>|<uscript>/* The quick brown fox jumps over the lazy dog */ // ...</uscript>}}

;Error, Unexpected end of file at end of Class : Usually caused by an unmatched pair of braces, missing "}"

;Error, Unexpected '.' following 'variable name' : accessor usage on a [[class]] scope [[variable]] that doesnt exist.

===Replication===
;Error, Unrecognized variable 'variable name' name in replication definition : A name in a [[replication condition]] does not correspond to any existing variable or (prior to {{UE3}}) function within the same class.

===Conflicts===
;Error, 'Function Name' conflicts with 'Function Package.Class<nowiki>:</nowiki>FunctionName' :

;Error, Redefinition of '[[function]] FUNCNAME' differs from original in [[class|CLASSNAME]] : You either want to override a function but the number or type of parameters in the definition of the parent class differs from your redefinition, or you accidentally chose a name for your function that is already used by a super class, so you will wish to choose another unambiguous name.

===Bad or missing expression===
;Error, Bad or missing expression in parenthesis for '='

;Error, Bad or missing expression in parenthesis for Following '&&'

;Error, Bad or missing expression in '[[If]]' : a function in an if statement does not return a type.

;Error, Bad or missing expression in Call to '[[Function]]', parameter ''number'' :

;Error, Bad or missing expression for token<nowiki>:</nowiki> '[[Function]]', in '[[Return]]' :

;Error, Bad or missing expression for token<nowiki>:</nowiki> '[[Variable]]', in '[[If]]' : To note in this case the variable was an actor reference.

;Error, Bad or missing expression for token<nowiki>:</nowiki> '[[Variable]]', in Call to '[[Function]]', parameter X :

;Error, Bad or missing expression after '[[Operator|OPERATORNAME]]'
;Error, Bad or missing expression after '[[Operator|OPERATORNAME]]'<nowiki>:</nowiki> '[[Variable|VARIABLENAME]]' : + being an incorrect operator usage? '&&'

;Error, '[[type]]' conversion<nowiki>:</nowiki> Bad or missing expression

;Error, Bad or missing expression in '[[NameOf]]'

;Error, 'class name'<nowiki>:</nowiki> Bad command or expression :

===Missing===
;Error, Missing 'function' : Declared a function modifier without a function, defined a function type before function.
{{CorrectWrong|<uscript>final function int FuncName()</uscript>|
<uscript>final int FuncName() or final int function FuncName()</uscript>}}

;Error, Missing ')' in 'foreach array' : The variable inside the brackets of a foreach loop is not defined.

;Error, Missing ';' before 'variable name' : The variable you are trying to access through a typecast is not defined.

;Error, Missing ';' before ')' : End of line expected before the character.
{{CorrectWrong|<uscript>...
{
a = b;
}</uscript>|<uscript>...
{
a = b
}</uscript>}}

;Error, ImportText (''[[struct]]'')<nowiki>:</nowiki> Missing closing parenthesis<nowiki>:</nowiki>(''member1''='value',''member2='value'))

;Error, Missing variable name : Pretty sure this is caused by using a class limitor on an interface like so, var interface<goo> foo;

===Static Functions===
;Error, Can't call instance functions from within static functions : [[Static Function|Static functions]] can only call other static functions directly. Additionally this can happen if you are trying to call a non-static function via the "Class.static.FunctionName" call modifier.

;Error, You can only access default values of variables here : Tried to assign a non [[default variable]] a value, using a non [[default variable]] in a statement, assigning a variable a value from another that is not a default variable. There are instances where you can access non default variables in [[Static Function|Static functions]], if the variable is part of the function definition, a local variable.

===Mismatch===
;Error, Call to '[[function|FUNCTIONNAME]]'<nowiki>:</nowiki> type mismatch in parameter NUMBER
;Error, Type mismatch in Call to '[[function|FUNCTIONNAME]]', parameter ''number'' : the [[type]] of [[variable]] being passed to the function
parameter number specified is incorrect.

;Error, Type mismatch in '=' : you probably wanted to make a [[bool]]ean compare "==" but ended up assigning something to a variable.

;Error, [[Const]] mismatch with '+' :

;Error, Type mismatch in array index :

==Warnings==
;Warning, Unresolved reference to Class 'class name' :

;Warning, Unresolved reference to '''object'''

;Warning, Function parameter<nowiki>:</nowiki> 'function name' conflicts with previously defined field in 'class name' :

;Warning, ''[[function]]''<nowiki>:</nowiki> Missing return value : a function with a return type has no 'return' that could be reached, for example if the only return is in an if-block and thus can't be accessed in all cases.

;Warning, Using a non-qualified name (would have) found<nowiki>:</nowiki> object package.group.group.name

;Warning, '''friendly operator name'''_'''TypeNameTypeName'''<nowiki>:</nowiki> Missing return value : This is similar to function not having a return value but is the operator version, UScript supports operator overloading so the 'friendly operator name''' will be a reference to a table within the engine $ being Concat as an example.

;Warning, Class ''ClassName'' can't bind to DLL ''DLLPath'' : The DLL that should be bound to either doesn't exist in the Win32\UserCode directory or was compiled wrong, for example on another system with debug settings (they only work on the system they were compiled on).

;Warning, Variable declaration<nowiki>:</nowiki> 'VARIABLENAME' conflicts with previously defined field in 'CLASSNAME' : You should not redefine existing variables in subclasses using the ''var'' or ''local'' declaration since the variable is already available from the parent class.

;Warning, 'identifier' obscures 'identifier' in base class 'OBJECTNAME' :

;Warning, Variable is declared with '[[SerializeText]]' but this keyword only has meaning for [[Native]] variables :

===Local Variables===
;Warning, 'variable name' <nowiki>:</nowiki> unreferenced local variable : A variable is declared within a function and never assigned a value.

;Warning, 'variable name'<nowiki>:</nowiki> unused local variable : A local variable was declared and maybe the function even assigns a value to it, but the value is never accessed elsewhere in the function. (Functions returning a value need not assign that value to a variable, in case you were wondering.)

;Warning, 'variable name' <nowiki>:</nowiki> local variable used before assigned a value : A variable is referenced before it is assigned a value, which means it'll return the default value for that type, whether that is what you are looking for or not. This could be conditionally incorrect, the compiler doesn't check to see in which order things are carried out so it could in fact be wrong, hence only a warning.

===Replication===
;Warning, Reliabe/Unreliable keywords are no longer used in 'replication {}': Those keywords only apply to function replication and are function modifiers in {{UE3}}.

===Default Properties===
;Warning, Import failed for 'variable name'<nowiki>:</nowiki> property is config (Check to see if the property is listed in the DefaultProperties. It should only be listed in the specific .ini/.int file) : It was tried to assign a default value to a variable that was declared [[config]]. Such a variable is supposed to read it's value always from the associated [[udn3:ConfigurationFiles|INI]] file, so it doesn't make sense to assign it in code and not there.

;Warning, Unknown property in defaults<nowiki>:</nowiki> 'line from defaultproperties block' : A property in the defaults is not a defined variable.

;Warning, Invalid property value in defaults<nowiki>:</nowiki> ''property''=''value'' : A property in the defaults is not a defined variable.

;Warning, redundant data<nowiki>:</nowiki> 'line from defaultproperties block' : There can only be one assignment for a property per class definition, so you probably have a duplicate in the DefaultProperties.

;Warning, ObjectProperty package.class.property<nowiki>:</nowiki> unresolved reference to object'package.group.object' : The specified object could not be found in the package.

;Warning, Unable to parse parameter value '(''member1''=''value''))' in defaultproperties array operation<nowiki>:</nowiki> ''array<struct>''.add((''member1''=''value'',''member2''=''value'')) : A value for one of the members in your struct causes an error. This error may be given later or earlier on in the compiler output. For example, if a member contains a class reference to a class that the compiler cannot find, it will give this warning but also an unresolved reference warning and a property import error.

==Failure==
;Failed to load 'object package.group.name'<nowiki>:</nowiki> Failed to find object 'object package.group.name'

[[Category:Compiler]] [[Category:Compiler errors]]

User:Crusha

2012-03-16T08:37:39Z

Crusha:

=About Me=

The full nickname would be Crusha K. Rool, derived from that crocodile-villain from "Donkey Kong", but I prefer Crusha after all.

Since I am dedicated and addicted to UT2004's Onslaught gametype, I once started to get myself familiar with the Unreal Editor 3 and stuck with it down to the present day.

I am studying computer science at the moment and work in my spare time as coder for UDK projects, currently for Firehazard Studio.

Whenever I have some time between that, I try to improve my UltimateMappingTools (see below) or even do some mapping to help the UT2004 community to keep this marvelous game alive for more years to come.

=Projects=

==UE2==
===UltimateMappingTools===

UltimateMappingTools is a toolset started by me with the goal to gather all useful UT2k4-actors out there in one package to give level designers everything they could ever wish to do right at their hand. Several coders have contributed their work to it. I say "thank you" to all of them.

See this page for a full reference: [[User:Crusha/UltimateMappingTools|UltimateMappingTools]]

===DynamicWeather===

DynamicWeather is a toolset by MarZer that contains a whole bunch of actors to put more atmosphere into maps by controlling the natural forces. It is also included in my UltimateMappingTools.

I am '''NOT''' the creator of this actors, they are all done by '''Mark 'MarZer' Gillard'''. I just put the descriptions on my User page because User pages have some functionality for sub-pages that doesn't exist in other namespaces.

See this page for a full reference: [[User:Crusha/DynamicWeather|DynamicWeather]]

==UE3==
===UltimateSaveSystem===

UltimateSaveSystem is a ready-to-use solution for writing and reading variables from UnrealScript or Kismet into and from binary files, using unique names to find the value in the file. It is capable of saving Integer, Float, Boolean, Vector and String variables (with unlimited length).

See this page for a full reference: [[User:Crusha/UltimateSaveSystem|UltimateSaveSystem]]

Note: Epic provided their own solution in the meanwhile, so you should rather use their BasicSaveObject() and BasicLoadObject() as those are compatible with every platform the UDK deploys to and don't rely on DLLBind.

===GUIFramework===

This is a framework for creating menus, buttons and other components entirely in UnrealScript with the Canvas instead of having to rely on Scaleform, which requires expensive third-party tools such as Adobe Flash Professional.

I started this on my own and turned it into an open source SVN repository to improve it with anyone in the community willing to contribute.

You can download, contribute and find more information about it [http://code.google.com/p/unrealscript-gui-framework/ here].

=Maps=
I early specialized in technically and gameplay-related fine-tuning existing maps (with the author's permission) rather than creating much own stuff, so most of the maps in my "portfolio" owe their being to other guys.

==UT2004==
===ONS-Rail===
[http://forums.epicgames.com/showthread.php?t=724229 Original Thread]

This is a conversion of CTF-Rail to ONS, featuring a lot of NV-mayhem in a narrow corridor-like map with three different levels for Z-axis gameplay and toggleable doors at the Prime Nodes.

===ONS-{DX}Ameliorate===
[http://forums.epicgames.com/showthread.php?t=727952 Original Thread]

This is a conversion of CTF-Ameliorate to ONS, featuring two opposed residences in a sunset scene with a central island surrounded by a canalization and 4 storage halls. The map is mainly NV, except four Mantas.

===ONS-SavoIsland-K===
[http://forums.epicgames.com/showthread.php?t=728055 Original Thread]

This is a conversion of JB-SavoIsland to ONS and a co-production with Kentaro. The NV-match takes place on a beautiful South Sea island that allows to choose between a fight along the flat beaches or through the hilly inland.

===ONS-Sektor9-Veni-Vidi-Vici===
[http://www.gametracker.com/clan/freelancer/forum.php?thread=29819 Original Thread]

This map was mainly created by VK especially for our ONS-server, but I put a lot of technical and visual fine-tuning into it, so I think it's worth being mentioned here.
Gameplay is crazy, many )o(-vehicles and superweapons and narrow space.

===ONS-Sektor8-The-Battle-Continues===
[http://www.gametracker.com/clan/freelancer/forum.php?thread=32536 Original Thread]

Again another map from VK for our server to which I contributed much fine-tuning. This one is not as narrow as the other one (actually it allows a lot of distance fights in vehicles and Z-axis gameplay), but is not less chaotic. ;)

===ONS-Downtown===
[http://forums.epicgames.com/showthread.php?t=737300 Original Thread]

A rebuild of the UT3-map WAR-TankCrossing for ONS from scratch. The BSP was done by Sanch3z, following the original as accurately as possible, I was responsible for everything else (StaticMeshes, lighting, bot paths, pickups, etc.).

The map uses UltimateDestructibleEnvironment from my MappingTools for destroyable barricades to achieve the same effect as in the original.

===ONS-TankCrossing===
[http://forums.epicgames.com/showthread.php?t=743195 Original Thread]

A rebuild of the UT3-map WAR-TankCrossing for ONS from scratch. The map is still in alpha phase but will feature some intense fights about the control of the single Center Node and the escorting of a team's tank to the enemy PowerCore.

===ONS-GlobeTrotter===
An NV-map that currently only exists as concept. It will be one of the very few maps that makes excessive use of the Escher Physics Mutator (and thus won't work with any bots).

This was only a small selection from the map's I've been working on, but the other's don't have that many noticeable changes or are not supposed

=Contact=
You can contact me in these forums:

[http://www.gametracker.com/crusha_k_rool/ Gametracker]

[http://www.unrealed.info/forum/member.php?u=2140 UnrealEd.info (German site)]

[http://ut2004.titaninternet.co.uk/forums/member.php?u=1873 Titan Onslaught]

[http://forum.omnipotents.com/member.php?u=1703 Omnip)o(tents]

[http://www.vehiclemasters.co.uk/member.php?u=501 Vehicle Masters]

[http://forums.epicgames.com/member.php?u=1387267 Epic Games Forums]

User:Crusha/UltimateMappingTools/UltimateONSFactory

2011-11-14T20:02:04Z

Crusha: Fixed some red links.

=UltimateONSFactory=
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work.
{{infobox class
| class = UltimateONSFactory
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail. Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially. Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

==Properties==
===Property group 'Events'===
====PreSpawnEvent====
'''Type:''' [[name]]

Event to trigger before spawn. Not activated when the vehicle was trigger-spawned.

===Property group 'ONSVehicleFactory'===
====BlueTeamRotation====
'''Type:''' [[int]]

If bReverseBlueTeamDirection, the Vehicle will not turn by 180 degrees but by this value.

8192 = 45°; 16384 = 90°; 32768 = 180°; etc..
Negative values will rotate in the opposite direction.

===Property group 'UltimateONSFactory'===
====bCrushable====
'''Type:''' [[bool]]

Allow spawning over colliding actors.

====bEnabled====
'''Type:''' [[bool]]

Factory is triggered "on" at the beginning.

'''Default value:''' True

====bIndependentFactory====
'''Type:''' [[bool]]

PowerNode has no influence on the factory's activity or team number.

====bRandomFlip====
'''Type:''' [[bool]]

Neutral vehicles may face in BlueTeamRotation.

====bTriggeredSpawn====
'''Type:''' [[bool]]

If True, this factory will immediately spawn a vehicle when being triggered.

If False, triggering will enable the factory and untriggering will disable it.

====bUniqueVehicle====
'''Type:''' [[bool]]

Factory spawns only a limited number of vehicles, there will be no second one when they are destroyed.
MaxVehicleCount determines the number of vehicles that can be spawned.

====bUseStaticTeams====
'''Type:''' [[bool]]

Factory works only for one team.

====NotLockedForTeam====
'''Type:''' [[byte]]

This will always lock the Vehicles for the TeamNum that is NOT entered here.
255 is normal ONS, 0 will always lock this for Blue, 1 always for Red.

(Hack for Minigun turrets - it makes pretty much only sense to use this with them at the team's Core)

'''Default value:''' 255

====PreSpawnTime====
'''Type:''' [[float]]

Time before spawn to trigger PrepSpawn-Event and -Effect.

'''Default value:''' 2.0

====RetrySpawnTime====
'''Type:''' [[float]]

Interval to wait if spawn area is blocked.

'''Default value:''' 1.0

====StaticTeamNum====
'''Type:''' [[byte]]

0= red, 1= blue, 255= neutral / none

TeamNums are switched automatically on Reset, if necessary. This is primarily used in combination with bIndependentFactory.

====VehicleListBlue====
'''Type:''' [[array]]<{{tl|SpawnedVehicleProperties}}>

List for random vehicle spawn if blue has the factory

====VehicleListRed====
'''Type:''' [[array]]<{{tl|SpawnedVehicleProperties}}>

List for random vehicle spawn if red or neutral has the factory

====VehicleSelectionType====
'''Type:''' {{tl|EVehicleSelectionType}}

Which method should be used to select the vehicle for spawning.

===Internal variables===
====bInitiallyEnabled====
'''Type:''' [[bool]]

Needed for Reset().

====RadarRI====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateONSFactory#UltimateONSRadarHUDRI|UltimateONSRadarHUDRI]]

Takes care of spawning the HUDOverlay on the client.

====RandomArrayNumber====
'''Type:''' [[int]]

For accessing the properties of the individual vehicle

====SequentialArrayNumberRed====
'''Type:''' [[int]]

Same, but in a sequential order.

====SequentialArrayNumberBlue====
'''Type:''' [[int]]

Need seperate ones for Red and Blue.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#DrawType|DrawType]]
| [[UE2:Actor enums (UT2004)#EDrawType|DT_Sprite]]
|}

==Enums==
====ESpawnSize====
The size of the spawneffect particle ring around the vehicle to use.
;SIZE_None :
;SIZE_Scorpion :
;SIZE_Manta :
;SIZE_Raptor :
;SIZE_Hellbender :
;SIZE_Goliath :
;SIZE_Leviathan :

====EVehicleSelectionType====
Which method should be used to select the vehicle for spawning.
; VST_Random : Random from list, equal chances for everyone.
; VST_Probability : Use Probability values of the vehicle, so some vehicles are more likely than others.
; VST_Sequential : Always select the next entry from the list when spawning a new vehicle.
; VST_OnceRandom : Random as above, just that the choice will be used for the whole match.
; VST_OnceProbability : Use Probablity as above, just that the choice will be used for the whole match.

==Structs==
===SpawnedVehicleProperties===
A load of customization and you need to do it for every entry in the list and for red and blue separately. But it pays out.
; [[class]]<[[UE2:Vehicle (UT2004)|Vehicle]]> Vehicle : The vehicle that is spawned with this entry.
; [[int]] Health : Give the spawned Vehicle a custom Health value. 0 will use the Vehicle's default.
; [[float]] SpawnProbability : Used with bUseSpawnProbability. You can enter whatever you like, just the relative difference between the entries counts.
; [[name]] VehicleSpawnedEvent : Tag to be triggered upon spawning of this particular vehicle (additionally to the one of the factory itself). The vehicle will be the instigator.
; [[name]] VehicleDestroyedEvent : Tag to be triggered upon destruction of the vehicle. Vehicle must be a subclass of ONSVehicle for this to happen.
; {{tl|ESpawnSize}} SpawnEffectSize : The size of the spawneffect around the vehicle to use.
; [[bool]] bEjectDriver : Eject driver when vehicle gets destroyed instead of killing him.
; [[bool]] bEnterringDoesNotUnlock : Vehicle is not unlocked when a player enters it.
; [[float]] SpawnProtectionTime : The vehicle is shielded from any damage for this many seconds after spawn (spawn protection is lift immediately when a driver enters). 0 disables this, -1 means the vehicle is protected until someone enters it.
; [[bool]] bChangeMaxDesireability : If True, use a custom MaxDesirability value to tell bots if they should use the vehicle or not.
; [[float]] MaxDesireability : Default values are: Scorpion - 0.4; Hellbender - 0.5; Raptor, Cicada, Manta, SPMA, Paladin - 0.6; Goliath, Ion Tank - 0.8; Leviathan - 2.0. Go figure what matches your vehicle best.
; [[bool]] bTrackVehicleOnRadar : The vehicle's location will be shown in realtime on the RadarMap.
; [[bool]] bRadarVisibleToDriver : Should the vehicle be shown on the radar to it's driver? Only useful if you have a large delay between the updates and want to estimate where your team sees you on the radar.
; [[bool]] bRadarNeutralWhenEmpty : If true, the vehicle is drawn with white team color when it's left.
; [[bool]] bRadarHideWhenEmpty : If true, the vehicle is not drawn when it's empty.
; [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI#ERadarVehicleVisibility|UltimateRadarVehicleLRI]] RadarVehicleVisibility : Here you set to which players the vehicle is shown on the RadarMap.
; [[float]] RadarOwnerUpdateTime : How many seconds have to pass before the location of vehicle is updated for the owning team.
; [[float]] RadarEnemyUpdateTime : Same as above, just for enemies.
; [[bool]] bRadarFadeWithOwnerUpdateTime : If True, the icon on the radar map will interpolate between opaque and translucent as time passes between location updates on the radar.
; [[bool]] bRadarFadeWithEnemyUpdateTime : If False, the icon will always stay fully opaque.
; [[UE2:Material (UT2004)|Material]] RadarTexture : The texture that represents the vehicle on the radar. It should have an alpha channel and be set to TC_Clamp. A bunch of vehicle textures for the radar are delivered in the texture package that comes with this toolset.
; [[float]] RadarTextureScale : The image will be scaled by this factor.
; [[int]] RadarTextureRotationOffset : The image will be rotated by this (in Rotation Units), in case your texture doesn't face the right way (up is the direction the vehicle is driving to).

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#PostBeginPlay|ONSVehicleFactory.PostBeginPlay]]

Performs a check to notify the mapper if this actor is useless.
References the one and only VehicleLRIMaster in the map. If it doesn't exist yet, a new one is spawned.
Sets some inherited variables to the correct values, enables the factory if necessary and precaches all the vehicles in the array.

====PostNetBeginPlay====
{{code|event '''PostNetBeginPlay''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#PostNetBeginPlay|ONSVehicleFactory.PostNetBeginPlay]]

Activates the factory, either according to the closest ONSPowerNode (uses super function) or with a fixed team number, making the factory effectively independent from a PowerNode.

====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]

Remove this factory from the PowerCore's dynamic 'CloseActors'-array.
By doing this, destroying the closest Node will no longer disable this factory.
Executing at this point makes sure that the PostNetBeginPlay() of the PowerCore has been called already.

====Timer====
{{code|event '''Timer''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Timer|ONSVehicleFactory.Timer]]

The main function of this actor. It handles when to call which other function.

====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Trigger|ONSVehicleFactory.Trigger]]

Either enable or spawn directly if bTriggeredSpawn.

====UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]

Disable if not bTriggeredSpawn.

====VehicleDestroyed====
{{code|event '''VehicleDestroyed''' ([[UE2:Vehicle (UT2004)|Vehicle]] '''V''')}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#VehicleDestroyed|ONSVehicleFactory.VehicleDestroyed]]

VehicleCount gets reduced (if wished) and the LinkedReplicationInfo for the radar is removed, if one for this vehicle existed.

===Other instance functions===
====Activate====
{{code|function '''Activate''' ([[byte]] '''T''')}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Activate|ONSVehicleFactory.Activate]]

Activation depending on close Nodes.

====ChooseVehicle====
{{code|function '''ChooseVehicle''' ()}}

Sets the VehicleClass to a Vehicle from the currently valid array. The class can be chosen randomly or sequential. In any case is RandomArrayNumber the index of the chosen entry in the array, so that we can find the matching properties for this vehicle when it's spawned.

====Deactivate====
{{code|function '''Deactivate''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Deactivate|ONSVehicleFactory.Deactivate]]

Deactivation depending on close Nodes.

====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

Adjust this actor if the sides are switched in ONS and deletes all remaining vehicles on the map.

====SidesAreSwitched====
{{code|function [[bool]] '''SidesAreSwitched''' ()}}

Just to make the code more surveillable.

====SpawnBuildEffect====
{{code|function '''SpawnBuildEffect''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#SpawnBuildEffect|ONSVehicleFactory.SpawnBuildEffect]]

Spawns the BuildEffect emitter.

====SpawnVehicle====
{{code|function '''SpawnVehicle''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#SpawnVehicle|ONSVehicleFactory.SpawnVehicle]]

Spawns the chosen VehicleClass and applies the properties from the matching entry in the array. The creation of a LinkedReplicationInfo for the radar is also handled here, if necessary.

If the ChooseVehicle function chose an entry with an empty vehicle class, then the Timer is set back to the length of a RespawnTime to try it again.

====UpdatePrecacheMaterials====
{{code|simulated function '''UpdatePrecacheMaterials''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#UpdatePrecacheMaterials|ONSVehicleFactory.UpdatePrecacheMaterials]]

Loads all vehicles in the arrays into cache to have fast access during the game.

====VehicleArrayPrecache====
{{code|simulated function '''VehicleArrayPrecache''' ()}}

Loads all vehicles in the arrays into cache to have fast access during the game.

=UltimateONSRadarHUDRI=
{{infobox class
| class = UltimateONSRadarHUDRI
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}
{{autogenerated}}

Creates the HUDOverlay for the Ultimate ONS radar map. For the vehicle stuff
and so on.

==Properties==
====bCreatedOverlay====
'''Type:''' [[bool]]



====bRadarMutatorEnabled====
'''Type:''' [[bool]]

Disable radar functionality in that case.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#NetUpdateFrequency|NetUpdateFrequency]]
| 1.0
|}

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]



====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]



===Other instance functions===
====HasRadarMutator====
{{code|function [[bool]] '''HasRadarMutator''' ()}}



====HealDamage====
{{code|function [[bool]] '''HealDamage''' ([[int]] '''Amount''', [[UE2:Controller (UT2004)|Controller]] '''Healer''', [[class]]<[[UE2:DamageType (UT2004)|DamageType]]> '''DamageType''')}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#HealDamage|Actor.HealDamage]]



=UltimateRadarVehicleHUDOverlay=
{{infobox class
| class = UltimateRadarVehicleHUDOverlay
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = HudOverlay
| parent2 = Actor
| parent3 = Object
| custom = yes
}}
{{autogenerated}}
HUDOverlay for UltimateONSFactory

This Overlay displays the location of a Vehicle on the RadarMap in realtime.

==Properties==
====ONSHUD====
'''Type:''' [[UE2:ONSHUDOnslaught (UT2004)|ONSHUDOnslaught]]



====OnsIconScale====
'''Type:''' [[float]]



====PCOwner====
'''Type:''' [[UE2:PlayerController (UT2004)|PlayerController]]



====RadarPosX====
'''Type:''' [[float]]



====RadarPosY====
'''Type:''' [[float]]



====RadarRange====
'''Type:''' [[float]]



====RadarScale====
'''Type:''' [[float]]



====RadarTrans====
'''Type:''' [[float]]



====VehicleLRIMaster====
'''Type:''' {{cl|UltimateRadarVehicleLRIMaster}}



==Functions==
===Events===
====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]



===Other instance functions===
====bDrawRadar====
{{code|simulated function [[bool]] '''bDrawRadar''' ()}}



====DrawRadar====
{{code|simulated function '''DrawRadar''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''', [[float]] '''CenterRadarPosX''', [[float]] '''CenterRadarPosY''', [[float]] '''RadarWidth''', [[UE2:Object structs (UT2004)#Vector|Object.Vector]] '''MapCenter''')}}



====Render====
{{code|simulated function '''Render''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''')}}

'''Overrides:''' [[UE2:HudOverlay (UT2004)#Render|HudOverlay.Render]]

User:Crusha

2011-11-11T12:44:06Z

Crusha: /* UE3 */ Added link to the GUIFramework project

=About Me=

The full nickname would be Crusha K. Rool, derived from that crocodile-villain from "Donkey Kong", but I prefer Crusha after all.

Since I am dedicated and addicted to UT2004's Onslaught gametype, I once started to get myself familiar with the Unreal Editor 3 and stuck with it down to the present day.

Currently I work with a small team on several projects. One is a yet unannounced medieval multiplayer game, another is the official sequel to a not quite unsuccessful arena-FPS from the year 2002 and the last is a small hobby project that I am doing on my own.

Whenever I have some time between that, I try to finish my UltimateMappingTools (see below) to help the UT2004 community to keep this marvelous game alive for more years to come.

=Projects=

==UE2==
===UltimateMappingTools===

UltimateMappingTools is a toolset started by me with the goal to gather all useful UT2k4-actors out there in one package to give level designers everything they could ever wish to do right at their hand. Several coders have contributed their work to it. I say "thank you" to all of them.

See this page for a full reference: [[User:Crusha/UltimateMappingTools|UltimateMappingTools]]

===DynamicWeather===

DynamicWeather is a toolset by MarZer that contains a whole bunch of actors to put more atmosphere into maps by controlling the natural forces. It is also included in my UltimateMappingTools.

I am '''NOT''' the creator of this actors, they are all done by '''Mark 'MarZer' Gillard'''. I just put the descriptions on my User page because User pages have some functionality for sub-pages that doesn't exist in other namespaces.

See this page for a full reference: [[User:Crusha/DynamicWeather|DynamicWeather]]

==UE3==
===UltimateSaveSystem===

UltimateSaveSystem is a ready-to-use solution for writing and reading variables from UnrealScript or Kismet into and from binary files, using unique names to find the value in the file. It is capable of saving Integer, Float, Boolean, Vector and String variables (with unlimited length).

See this page for a full reference: [[User:Crusha/UltimateSaveSystem|UltimateSaveSystem]]

===GUIFramework===

This is a framework for creating menus, buttons and other components entirely in UnrealScript with the Canvas instead of having to rely on Scaleform, which requires expensive third-party tools such as Adobe Flash Professional.

I started this on my own and turned it into an open source SVN repository to improve it with anyone in the community willing to contribute.

You can download, contribute and find more information about it [http://code.google.com/p/unrealscript-gui-framework/ here].

=Maps=
I early specialized in technically and gameplay-related fine-tuning existing maps (with the author's permission) rather than creating much own stuff, so most of the maps in my "portfolio" owe their being to other guys.

==UT2004==
===ONS-Rail===
[http://forums.epicgames.com/showthread.php?t=724229 Original Thread]

This is a conversion of CTF-Rail to ONS, featuring a lot of NV-mayhem in a narrow corridor-like map with three different levels for Z-axis gameplay and toggleable doors at the Prime Nodes.

===ONS-{DX}Ameliorate===
[http://forums.epicgames.com/showthread.php?t=727952 Original Thread]

This is a conversion of CTF-Ameliorate to ONS, featuring two opposed residences in a sunset scene with a central island surrounded by a canalisation and 4 storage halls. The map is mainly NV, except four Mantas.

===ONS-SavoIsland-K===
[http://forums.epicgames.com/showthread.php?t=728055 Original Thread]

This is a conversion of JB-SavoIsland to ONS and a co-production with Kentaro. The NV-match takes place on a beautiful South Sea island that allows to choose between a fight along the flat beaches or through the hilly inland.

===ONS-Sektor9-Veni-Vidi-Vici===
[http://www.gametracker.com/clan/freelancer/forum.php?thread=29819 Original Thread]

This map was mainly created by VK especially for our ONS-server, but I put a lot of technical and visual fine-tuning into it, so I think it's worth being mentioned here.
Gameplay is crazy, many )o(-vehicles and superweapons and narrow space.

===ONS-Sektor8-The-Battle-Continues===
[http://www.gametracker.com/clan/freelancer/forum.php?thread=32536 Original Thread]

Again another map from VK for our server to which I contributed much fine-tuning. This one is not as narrow as the other one (actually it allows a lot of distance fights in vehicles and Z-axis gameplay), but is not less chaotic. ;)

===ONS-Downtown===
[http://forums.epicgames.com/showthread.php?t=737300 Original Thread]

A rebuild of the UT3-map WAR-TankCrossing for ONS from scratch. The BSP was done by Sanch3z, following the original as accurately as possible, I was responsible for everything else (StaticMeshes, lighting, bot paths, pickups, etc.).

The map uses UltimateDestructibleEnvironment from my MappingTools for destroyable barricades to achieve the same effect as in the original.

===ONS-TankCrossing===
[http://forums.epicgames.com/showthread.php?t=743195 Original Thread]

A rebuild of the UT3-map WAR-TankCrossing for ONS from scratch. The map is still in alpha phase but will feature some intense fights about the control of the single Center Node and the escorting of a team's tank to the enemy PowerCore.

===ONS-GlobeTrotter===
An NV-map that currently only exists as concept. It will be one of the very few maps that makes excessive use of the Escher Physics Mutator (and thus won't work with any bots).

This was only a small selection from the map's I've been working on, but the other's don't have that many noticeable changes or are not supposed

=Contact=
You can contact me in these forums:

[http://www.gametracker.com/crusha_k_rool/ Gametracker]

[http://www.unrealed.info/forum/member.php?u=2140 UnrealEd.info (German site)]

[http://ut2004.titaninternet.co.uk/forums/member.php?u=1873 Titan Onslaught]

[http://forum.omnipotents.com/member.php?u=1703 Omnip)o(tents]

[http://www.vehiclemasters.co.uk/member.php?u=501 Vehicle Masters]

[http://forums.epicgames.com/member.php?u=1387267 Epic Games Forums]

User:Crusha/UltimateMappingTools

2011-10-23T15:00:05Z

Crusha: /* Download */ Added link to DWeather test map

=Introduction=

==About this site==
This site is dedicated to my extensive toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actor.

Please do not apply any changes on this site, I will maintain it on my own. But the discussion page can be used for feedback. Or simply post in one of the threads in the countless UT forums where I posted this. :)

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Download=
==UltimateMappingTools==
The compiled scripts and all necessary texture and mesh packages.

[http://www.mediafire.com/?2aogafm2tggidc8 Download from Mediafire] (582.41 KB, Zip)

==DWeather Wind Test==
This is a small VCTF test arena created by MarZer in order to show off some dynamic weather effects that react to changing wind. In this example is the direction of the smoke from fireplaces influenced by the randomly changing wind direction, as well as the direction in which the twister is moving. Furthermore does the map feature Raptors that shoot powerful meteors (so you can get an idea of how devastating a real meteor hail is) as well as earthquakes that shake your view and throw you around and some weak ambient monsters and hail, which may hurt you if it happens to hit you (which is not all that likely after all).

[http://www.mediafire.com/?pek49s741249548 Download from Mediafire] (588.65 KB, Zip)

=Related=
Not included are [[User:Wormbo/OnslaughtSpecials|Wormbo's OnslaughtSpecials]], since he maintains them himself. But they fit perfectly together with the UltimateMappingTools, so you should really get them as well. Unless you are not mapping for ONS.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=TeamSpecificActors=
by Jrubzjeknf (aka Nova^)

These are modified versions of the default UT2k4 Actors that can be set to work for a specific team only. The associated team of the Actors is swapped in ONS on reset, if necessary. The Actors also have individual Actor icons to distinguish them from normal Actors.

The latest version of these Actors is included in the UltimateMappingTools package.

See [[User:Jrubzjeknf/TeamSpecificActors|Nova's User Page]] for a full reference.

=DynamicWeather=
by Mark 'MarZer' Gillard

DynamicWeather is a toolset that contains a whole bunch of Actors to put more atmosphere into maps by controlling the natural forces.
These tools are provided without support, but they are definitely awesome, so I included them. ;)

See [[User:Crusha/DynamicWeather|this page]] for a full reference.

=Assets=
With this UltimateMappingTools.u file comes a UltimateMappingTools_Tex.utx file which holds some Actor symbols that make it easier to distinguish some of these Actors from the rest.
It is automatically loaded with the .u file.

Inside the UTX are also vehicle icons for the radar map that have been taken from UT3 and cleaned in GIMP, so if you hit the "Load Entire Package" button for the UltimateMappingTools_Tex.utx, you should get more icons for vehicles to be used with the radar tracking system than there are actually vehicles in UT2k4. But feel free to use your own textures if you prefer them. :)

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

UltimateMappingTools

2011-10-23T14:22:55Z

Crusha: Redirect link

#REDIRECT [[User:Crusha/UltimateMappingTools]]

User:Crusha/UltimateMappingTools

2011-10-14T16:02:02Z

Crusha: /* About this site */ It's not "upcoming" anymore. :)

=Introduction=

==About this site==
This site is dedicated to my extensive toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actor.

Please do not apply any changes on this site, I will maintain it on my own. But the discussion page can be used for feedback. Or simply post in one of the threads in the countless UT forums where I posted this. :)

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Download=
[http://www.mediafire.com/?2aogafm2tggidc8 Download from Mediafire] (493.3 KB, Zip)

=Related=
Not included are [[User:Wormbo/OnslaughtSpecials|Wormbo's OnslaughtSpecials]], since he maintains them himself. But they fit perfectly together with the UltimateMappingTools, so you should really get them as well. Unless you are not mapping for ONS.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=TeamSpecificActors=
by Jrubzjeknf (aka Nova^)

These are modified versions of the default UT2k4 Actors that can be set to work for a specific team only. The associated team of the Actors is swapped in ONS on reset, if necessary. The Actors also have individual Actor icons to distinguish them from normal Actors.

The latest version of these Actors is included in the UltimateMappingTools package.

See [[User:Jrubzjeknf/TeamSpecificActors|Nova's User Page]] for a full reference.

=DynamicWeather=
by Mark 'MarZer' Gillard

DynamicWeather is a toolset that contains a whole bunch of Actors to put more atmosphere into maps by controlling the natural forces.
These tools are provided without support, but they are definitely awesome, so I included them. ;)

See [[User:Crusha/DynamicWeather|this page]] for a full reference.

=Assets=
With this UltimateMappingTools.u file comes a UltimateMappingTools_Tex.utx file which holds some Actor symbols that make it easier to distinguish some of these Actors from the rest.
It is automatically loaded with the .u file.

Inside the UTX are also vehicle icons for the radar map that have been taken from UT3 and cleaned in GIMP, so if you hit the "Load Entire Package" button for the UltimateMappingTools_Tex.utx, you should get more icons for vehicles to be used with the radar tracking system than there are actually vehicles in UT2k4. But feel free to use your own textures if you prefer them. :)

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools

2011-10-13T20:00:30Z

Crusha: Typo in a wormy cross-promotion. :>

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Download=
[http://www.mediafire.com/?2aogafm2tggidc8 Download from Mediafire] (493.3 KB, Zip)

=Related=
Not included are [[User:Wormbo/OnslaughtSpecials|Wormbo's OnslaughtSpecials]], since he maintains them himself. But they fit perfectly together with the UltimateMappingTools, so you should really get them as well. Unless you are not mapping for ONS.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=TeamSpecificActors=
by Jrubzjeknf (aka Nova^)

These are modified versions of the default UT2k4 Actors that can be set to work for a specific team only. The associated team of the Actors is swapped in ONS on reset, if necessary. The Actors also have individual Actor icons to distinguish them from normal Actors.

The latest version of these Actors is included in the UltimateMappingTools package.

See [[User:Jrubzjeknf/TeamSpecificActors|Nova's User Page]] for a full reference.

=DynamicWeather=
by Mark 'MarZer' Gillard

DynamicWeather is a toolset that contains a whole bunch of Actors to put more atmosphere into maps by controlling the natural forces.
These tools are provided without support, but they are definitely awesome, so I included them. ;)

See [[User:Crusha/DynamicWeather|this page]] for a full reference.

=Assets=
With this UltimateMappingTools.u file comes a UltimateMappingTools_Tex.utx file which holds some Actor symbols that make it easier to distinguish some of these Actors from the rest.
It is automatically loaded with the .u file.

Inside the UTX are also vehicle icons for the radar map that have been taken from UT3 and cleaned in GIMP, so if you hit the "Load Entire Package" button for the UltimateMappingTools_Tex.utx, you should get more icons for vehicles to be used with the radar tracking system than there are actually vehicles in UT2k4. But feel free to use your own textures if you prefer them. :)

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools

2011-10-13T19:59:22Z

Crusha: Added download link (!!!!!) and links to TeamSpecificActors and DynamicWeatherActors. Also I get a warning that the page is bigger than 32 kB (33 kB), but I hope it will work out. :>

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Download=
[http://www.mediafire.com/?2aogafm2tggidc8 Download from Mediafire] (493.3 KB, Zip)

=Related=
Not included are [[User:Wormbo/OnslaughtSpecialsWormbo's OnslaughtSpecials]], since he maintains them himself. But they fit perfectly together with the UltimateMappingTools, so you should really get them as well. Unless you are not mapping for ONS.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=TeamSpecificActors=
by Jrubzjeknf (aka Nova^)

These are modified versions of the default UT2k4 Actors that can be set to work for a specific team only. The associated team of the Actors is swapped in ONS on reset, if necessary. The Actors also have individual Actor icons to distinguish them from normal Actors.

The latest version of these Actors is included in the UltimateMappingTools package.

See [[User:Jrubzjeknf/TeamSpecificActors|Nova's User Page]] for a full reference.

=DynamicWeather=
by Mark 'MarZer' Gillard

DynamicWeather is a toolset that contains a whole bunch of Actors to put more atmosphere into maps by controlling the natural forces.
These tools are provided without support, but they are definitely awesome, so I included them. ;)

See [[User:Crusha/DynamicWeather|this page]] for a full reference.

=Assets=
With this UltimateMappingTools.u file comes a UltimateMappingTools_Tex.utx file which holds some Actor symbols that make it easier to distinguish some of these Actors from the rest.
It is automatically loaded with the .u file.

Inside the UTX are also vehicle icons for the radar map that have been taken from UT3 and cleaned in GIMP, so if you hit the "Load Entire Package" button for the UltimateMappingTools_Tex.utx, you should get more icons for vehicles to be used with the radar tracking system than there are actually vehicles in UT2k4. But feel free to use your own textures if you prefer them. :)

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools

2011-10-13T14:32:03Z

Crusha: Added asset description.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=Assets=
With this UltimateMappingTools.u file comes a UltimateMappingTools_Tex.utx file which holds some Actor symbols that make it easier to distinguish some of these Actors from the rest.
It is automatically loaded with the .u file.

Inside the UTX are also vehicle icons for the radar map that have been taken from UT3 and cleaned in GIMP, so if you hit the "Load Entire Package" button for the UltimateMappingTools_Tex.utx, you should get more icons for vehicles to be used with the radar tracking system than there are actually vehicles in UT2k4. But feel free to use your own textures if you prefer them. :)

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/UltimateMathAux

2011-10-13T14:25:55Z

Crusha: First revision of page. Checked for correctness.

{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

==Static functions==
====ArcTan====
{{code|static final function [[float]] '''ArcTan''' ([[float]] '''A''')}}

The one-parameter version. By Wormbo.

====VSizeSq====
{{code|static final function [[float]] '''VSizeSq''' ([[UE2:Object structs (UT2004)#Vector|Object.Vector]] '''A''')}}

Returns the squared length of a vector. Cheaper than VSize().

==Operators==
====int % int====
{{code|static final operator(18) [[int]] '''%''' ([[int]] '''A''', [[int]] '''B''')}}

Modulo for integers. Courtesy of a Worm.

User:Crusha/UltimateMappingTools

2011-10-13T14:23:16Z

Crusha: /* Fix */ Merged section for NIV and NLCV.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/NetworkImportanceVolume

2011-10-13T14:21:57Z

Crusha: Fixed.

=NetworkImportanceVolume=
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Forces all Actors inside to be always relevant to network clients. Keep this
Volume of a reasonable size.
This should be used with an OnlineCameraTextureClient because it makes everything
in it relevant to the player, also if he can actually only see the place
through the camera.

==Properties==
===Property group 'NetworkImportanceVolume'===
====bMakeInitialActorsAlwaysRelevant====
'''Type:''' [[bool]]

All Actors that are inside at the beginning of the match will be made relavant as well. This is just a fail-safe, in case Touch only gets called for stuff that enters new.

====NetworkLinkedClientVolumeTag====
'''Type:''' [[name]]

Tag of all NetworkLinkedClientVolumes that are associated with this Volume.

====RelevantClasses====
'''Type:''' [[array]]<[[class]]<[[UE2:Actor (UT2004)|Actor]]> >

Anything special you want to make relevant? Pawn and Projectile should be enough otherwise.

===Internal variables===
====bEnabled====
'''Type:''' [[bool]]



====RelevantLinkedClientVolumes====
'''Type:''' [[int]]



====TemporaryRelevantActors====
'''Type:''' [[array]]<[[UE2:Actor (UT2004)|Actor]]>



==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Volume (UT2004)#PostBeginPlay|Volume.PostBeginPlay]]



====Touch====
{{code|event '''Touch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Touch|Actor.Touch]]



====UnTouch====
{{code|event '''UnTouch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTouch|Actor.UnTouch]]



===Other instance functions===
====CheckClassRelevance====
{{code|function [[bool]] '''CheckClassRelevance''' ([[UE2:Actor (UT2004)|Actor]] '''A''')}}



====UpdateVolume====
{{code|singular function '''UpdateVolume''' ()}}



=NetworkLinkedClientVolume=
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only
active if actual players are inside this Volume.

This should be used in the area from which a player can see an
OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players.

==Properties==
===Property group 'NetworkLinkedClientVolume'===
====UpdateTime====
'''Type:''' [[float]]

How often this checks for PlayerControllers in it.

'''Default value:''' 5.0

===Internal variables===
====bHasRelevantPlayers====
'''Type:''' [[bool]]



====bOldRelevantPlayers====
'''Type:''' [[bool]]

Remember if we had players at the last check.

====MyTimer====
'''Type:''' [[UE2:VolumeTimer (UT2004)|VolumeTimer]]



====ParentNIVolume====
'''Type:''' [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|NetworkImportanceVolume]]



==Functions==
===Events===
====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]



===Other instance functions===
====TimerPop====
{{code|function '''TimerPop''' ([[UE2:VolumeTimer (UT2004)|VolumeTimer]] '''T''')}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#TimerPop|Actor.TimerPop]]

User:Crusha/UltimateMappingTools/NetworkImportanceVolume

2011-10-13T14:21:23Z

Crusha: First revision of page. Checked for correctness but still a lot autogenerated.

=NetworkImportanceVolume=
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Forces all Actors inside to be always relevant to network clients. Keep this
Volume of a reasonable size.
This should be used with an OnlineCameraTextureClient because it makes everything
in it relevant to the player, also if he can actually only see the place
through the camera.

==Properties==
===Property group 'NetworkImportanceVolume'===
====bMakeInitialActorsAlwaysRelevant====
'''Type:''' [[bool]]

All Actors that are inside at the beginning of the match will be made relavant as well. This is just a fail-safe, in case Touch only gets called for stuff that enters new.

====NetworkLinkedClientVolumeTag====
'''Type:''' [[name]]

Tag of all NetworkLinkedClientVolumes that are associated with this Volume.

====RelevantClasses====
'''Type:''' [[array]]<[[class]]<[[UE2:Actor (UT2004)|Actor]]> >

Anything special you want to make relevant? Pawn and Projectile should be enough otherwise.

===Internal variables===
====bEnabled====
'''Type:''' [[bool]]



====RelevantLinkedClientVolumes====
'''Type:''' [[int]]



====TemporaryRelevantActors====
'''Type:''' [[array]]<[[UE2:Actor (UT2004)|Actor]]>



==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Volume (UT2004)#PostBeginPlay|Volume.PostBeginPlay]]



====Touch====
{{code|event '''Touch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Touch|Actor.Touch]]



====UnTouch====
{{code|event '''UnTouch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTouch|Actor.UnTouch]]



===Other instance functions===
====CheckClassRelevance====
{{code|function [[bool]] '''CheckClassRelevance''' ([[UE2:Actor (UT2004)|Actor]] '''A''')}}



====UpdateVolume====
{{code|singular function '''UpdateVolume''' ()}}



=NetworkLinkedClientVolume=
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only
active if actual players are inside this Volume.

This should be used in the area from which a player can see an
OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players.

==Properties==
===Property group 'NetworkLinkedClientVolume'===
====UpdateTime====
'''Type:''' [[float]]

How often this checks for PlayerControllers in it.

'''Default value:''' 5.0

===Internal variables===
====bHasRelevantPlayers====
'''Type:''' [[bool]]



====bOldRelevantPlayers====
'''Type:''' [[bool]]

Remember if we had players at the last check.

====MyTimer====
'''Type:''' [[UE2:VolumeTimer (UT2004)|VolumeTimer]]



====ParentNIVolume====
'''Type:''' {{cl|NetworkImportanceVolume}}



==Functions==
===Events===
====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]



===Other instance functions===
====TimerPop====
{{code|function '''TimerPop''' ([[UE2:VolumeTimer (UT2004)|VolumeTimer]] '''T''')}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#TimerPop|Actor.TimerPop]]

User:Crusha/UltimateMappingTools/VIPlayerEventGate

2011-10-13T14:16:29Z

Crusha: Updated to newest version.

=VIPlayerEventGate=
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about
the Instigator of this Event. It will (un)trigger the next Event, depending on
what the result of the check is.

==Properties==
===Property group 'Events'===
====BlacklistEvent====
'''Type:''' [[name]]

The optional event that is (un)triggered if the Instigator is in the BlackList.

====NoMatchEvent====
'''Type:''' [[name]]

The optional event that is (un)triggered if the Instigator is not in the WhiteList.

===Property group 'VIPlayerEventGate'===
====bKillWarezPlayers====
'''Type:''' [[bool]]

Kill the Instigator immediately, if he's using a demo CD-key. Otherwise nothing happens, no Event will be triggered at all.

====Blacklist====
'''Type:''' [[array]]<{{tl|_PlayerProperties}}>

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

The normal event will not be called for players matching these criteria. Instead will the BlacklistEvent be called.

====Whitelist====
'''Type:''' [[array]]<{{tl|_PlayerProperties}}>

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

The Instigators with these criteria trigger the default Event.

===Internal variables===
====WAREZ_ID====
'''Type:''' [[string]]

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

The hash of the demo key.

'''Default value:''' "238c7dd4ec4a065e2314c1c8b4d41ca6"

==Enums==
====ECheckResult====
What the result of the check can/must be to be valid.

==Structs==
===_PlayerProperties===
All these criteria per array entry have to be valid at once.
; [[string]] PlayerName : This string must be contained in the Instigator's name. Leaving this blank disables the criterium.
; [[bool]] bCheckExactName : Instigator's name must be EXACTLY the one entered in the PlayerName-field. (Unless the field is blank)
; {{tl|ECheckResult}} MustBeAdmin : Player must be logged in with server admin rights.
; {{tl|ECheckResult}} MustBeBot : Player must be a bot.
; [[bool]] bVehicleCheck : True to check whether the Instigator is in the RequiredVehicle, False to ignore this criteria.
; [[class]]<[[UE2:Vehicle (UT2004)|Vehicle]]> RequiredVehicle : The Instigator must be in this vehicle. None = must go by foot ; Vehicle = can be any vehicle.
; [[string]] PlayerID : Instigator needs to have this exact sequence of characters somewhere in his hash ID. The longer the sequence, the less the chance of a false-positive, but you should never ever put your full ID there. It's really hard if not nearly impossible to bruteforce the MD5 hash back into the original key but who knows what people do when they have too much time and bad intentions.
; [[int]] MinimumRequiredScore : Instigator needs to have at least this much points. Enter a very low value to let everyone pass this check. ;)
; [[int]] TeamIndex : Instigator needs to be in this specific team. 0= red, 1= blue, 255= disable check

==Functions==
===Events===
====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Trigger|Actor.Trigger]]

Let's call the check.

====UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]

Let's call the Check.

===Other instance functions===
====PerformCheck====
{{code|function [[bool]] '''PerformCheck''' ([[UE2:Pawn (UT2004)|Pawn]] '''Instigator''', [[bool]] '''bBlacklist''')}}

Run all the criteria checks on the Instigator.

=Author comments=
This actor is supposed to allow authorized personnel like Admins, clan members or the mapper himself to cause certain Events in the map, what can become pretty handy in conjunction with other actors of my tool set.

However, this actor is basically also a way to let the mapper do certain things to certain players which might not be fair, for example healing one kind of players and keeping the other kind of players from using a certain door, etc.

There are many ways how such a thing can be abused, but I follow the rule that I just offer you the tools and it's about you what you do with them. Keep in mind that players won't play your map if they feel like you give certain players advantages over the others and there is nothing they can do about it.
No Admin will put such a map up in which you abuse this tool, unless he can bear to become a pretty empty server quickly.

I also added the restriction to distinguish players with the demo CD-key. Ok, killing them might be too hard, that's why I integrated it optionally, but I somehow found that it would be fair that those who paid for the game has the right to play it in it's full spectrum while the other guys have exceeded their testing time and shouldn't get all the features. Seriously, just buy the game if you haven't done yet.

User:Crusha/UltimateMappingTools/CountdownEventGate

2011-10-13T14:04:42Z

Crusha: First revision of page. Checked for correctness.

=CountdownEventGate=
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
The condition mustn't be untriggered in that time, or the countdown stops.
There is a ToleranceTime in which the event can be triggered again to
continue the current countdown.

==Properties==
===Property group 'CountdownEventGate'===
====bBroadcastCountdown====
'''Type:''' [[bool]]

Countdown will be broadcasted to the HUD.

'''Default value:''' True

====bLoopCountdown====
'''Type:''' [[bool]]

Triggers the Event all CountdownTime seconds until this gets untriggered.

====BlueTeamMessages====
'''Type:''' {{tl|TeamMessage}}

Specific countdown messages for the blue team.

====bNoUntrigger====
'''Type:''' [[bool]]

This will only trigger an event but never untrigger it.

====bSubtileCounting====
'''Type:''' [[bool]]

If True, the timer will only appear in certain intervals. Otherwise it's always visible when the countdown is active.

====bSwitchMessageTeamsAfterReset====
'''Type:''' [[bool]]

Use all RedTeamMessages on the blue team in swapped rounds and the other way around.

'''Default value:''' True

====CountdownPosX====
'''Type:''' [[float]]

The relative location of the countdown in the HUD.

====CountdownPosY====
'''Type:''' [[float]]

Only the countdown - not the messages.

====CountdownString====
'''Type:''' [[string]]

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

Displayed with the countdown. %c in the string will be replaced with a numerical representation of the countdown.

====CountdownTime====
'''Type:''' [[float]]

Wait for the CountdownTime before triggering the Event.

The Event will not get triggered if a part of the condition becomes False during the countdown. 0 disables this, but makes no sense.

'''Default value:''' 60.0

====MessageType====
'''Type:''' {{tl|EMT_MessageType}}

The place and font for all messages to use.

'''Default value:''' {{tl|EMT_MessageType|||EMT_CriticalEvent}}

====RedTeamMessages====
'''Type:''' {{tl|TeamMessage}}

Specific countdown messages for the red team.

====ScoreFontSize====
'''Type:''' [[int]]

This int size controls how big the font is at different resolutions. -2 is normally quite good.

====ToleranceTime====
'''Type:''' [[float]]

If the whole condition gets False after being true, then you have this much time to get it True again to keep your CountdownTime progress. Otherwise you start over again. 0 disables this.

===Property group 'Events'===
====CountdownStoppedEvent====
'''Type:''' [[name]]

This will be triggered when the condition gets untriggered.
You can use it to do something when the ToleranceTime starts.

====ToleranceStoppedEvent====
'''Type:''' [[name]]

This will be triggered when the condition gets triggered while the gate is in ToleranceTime.

===Internal variables===
====BlueTeam====
'''Type:''' [[byte]]

For Reset()

====bMainCountdown====
'''Type:''' [[bool]]

Do the main thing, not the tolerance.

====bWasTolerance====
'''Type:''' [[bool]]

Whether this actor was just in Tolerance, so write the ToleranceAbort-Msg.

====CountdownProgress====
'''Type:''' [[float]]

Saves the last CountdownTime for later re-use.

====CountdownProgressInt====
'''Type:''' [[int]]

Typecast it once to save performance.

====MSGType====
'''Type:''' [[name]]



====RedTeam====
'''Type:''' [[byte]]

For Reset()

====TempInstigator====
'''Type:''' [[UE2:Pawn (UT2004)|Pawn]]

Remember, because of a gap to the next TriggerEvent.

====ToleranceProgress====
'''Type:''' [[float]]



===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#NetUpdateFrequency|NetUpdateFrequency]]
| 2.0
|-
| [[UE2:Actor internal variables (UT2004)#RemoteRole|RemoteRole]]
| [[UE2:Actor enums (UT2004)#ENetRole|Role_SimulatedProxy]]
|}

==Enums==
====EMT_MessageType====

; EMT_Default : Comment in chat window.
; EMT_CriticalEvent : Big font on the center of the screen.
; EMT_DeathMessage : Small in chat window.
; EMT_Say : Small in chat window.
; EMT_TeamSay : Small in chat window.

==Structs==
===TeamMessage===

; [[string]] MsgCountdownStart : Message to display when the Countdown starts.
; [[string]] MsgCountdownSuccess : Message to display when the Countdown runs out.
; [[string]] MsgCountdownAbort : Message to display when the Countdown is aborted in time.
; [[string]] MsgToleranceSuccess : Message to display when the ToleranceTime runs out.
; [[string]] MsgToleranceAbort : Message to display when this is retriggered in the ToleranceTime.

==Functions==
===Events===
====BeginPlay====
{{code|event '''BeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#BeginPlay|Actor.BeginPlay]]



====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]



====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]



===Other instance functions===
====DisplayHUDMessage====
{{code|function '''DisplayHUDMessage''' ([[string]] '''Message''', [[byte]] '''TeamNum''')}}



====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]



==States==
===ClientTick===


====ClientTick.Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]] ''(global)''



===ServerTick===


====ServerTick.Tick====
{{code|event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]] ''(global)''



====ServerTick.Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Trigger|Actor.Trigger]] ''(global)''



====ServerTick.UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]] ''(global)''



=CountdownHUDOverlay=
by Crusha K. Rool
{{infobox class
| class = CountdownHUDOverlay
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = HudOverlay
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Allows to specify a custom position to display the countdown in the HUD.

==Properties==
====CountdownProgressInt====
'''Type:''' [[int]]

Typecasted version of the countdown since floating points would be too confusing.

====ParentCountdown====
'''Type:''' [[User:Crusha/UltimateMappingTools/CountdownEventGate|CountdownEventGate]]

The CountdownEventGate that we watch.

====PCOwner====
'''Type:''' [[UE2:PlayerController (UT2004)|PlayerController]]

The PlayerController that owns this HUD.

====ScoreFontSize====
'''Type:''' [[int]]

The font size we will be using.

==Instance functions==
====DisplayCountdown====
{{code|function '''DisplayCountdown''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''')}}



====Render====
{{code|function '''Render''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''')}}

'''Overrides:''' [[UE2:HudOverlay (UT2004)#Render|HudOverlay.Render]]

User:Crusha/UltimateMappingTools/RandomEventGate

2011-10-13T13:50:50Z

Crusha: First revision of page. Checked for correctness.

by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one
is not chosen.

==Properties==
===Property group 'Events'===
====AlternativeEvent====
'''Type:''' [[name]]

Event to trigger in other case.

===Property group 'RandomEventGate'===
====TriggerProbability====
'''Type:''' [[float]]

Value between 0 and 100. How likely it is to trigger the regular event. Otherwise the AlternativeEvent will be triggered.

====UnTriggerProbability====
'''Type:''' [[float]]

Value between 0 and 100. How likely it is to untrigger the regular event. Otherwise the AlternativeEvent will be untriggered.

==Events==
====BeginPlay====
{{code|event '''BeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#BeginPlay|Actor.BeginPlay]]

Checking if it actually makes sense to use this Actor.

====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Trigger|Actor.Trigger]]

Some simple FRand() magic.

====Untrigger====
{{code|event '''Untrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]

More FRand().

User:Crusha/UltimateMappingTools/PlayerCountTrigger

2011-10-13T13:46:36Z

Crusha: First revision of page. Checked for correctness.

by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount.

Hint: Use a LogicalNOT to make this thing work in the other direction,
so that it triggers if less than x players are in the game.

==Properties==
===Property group 'PlayerCountTrigger'===
====bCountHumansOnly====
'''Type:''' [[bool]]

Bots are not considered in the PlayerCount.

====PlayerCount====
'''Type:''' [[byte]]

Triggers the Event when at least this much players are in the game.

'''Default value:''' 16

===Internal variables===
====bHasTriggeredAlready====
'''Type:''' [[bool]]

So that we don't trigger again when another player joins although we are above PlayerCount already.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#bCollideActors|bCollideActors]]
| False
|}

==Functions==
===Events===
====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]

Go to the appropriate state, either for humans only or also for bots. With states can we save more performance than with boolean checks.

===Other instance functions===
====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

The Event will be untriggered and is allowed to trigger again in the next Tick.

==States==
===HumansAndBots===
Counts bots too.

====HumansAndBots.Tick====
{{code|event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]] ''(global)''

Checking Level.Game.NumPlayers + Level.Game.NumBots every Tick.

===HumansOnly===
Count only humans, bots can not be taken as serious players.

====HumansOnly.Tick====
{{code|event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]] ''(global)''

Checking Level.Game.NumPlayers every Tick.

User:Crusha/UltimateMappingTools/ProjectileTeleporter

2011-10-13T13:38:58Z

Crusha: First revision of page. Checked for correctness.

by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

==Properties==
===Property group 'Teleporter'===
====AllowedProjectiles====
'''Type:''' [[array]]<[[class]]<[[UE2:Projectile (UT2004)|Projectile]]> >

Which projectiles are allowed to pass through. By default are all allowed.

'''Default value:''' [[Types#Class|Class]]'[[UE2:Projectile (UT2004)|EngineProjectile]]'

==Functions==
===Events===
====Touch====
{{code|event '''Touch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:Teleporter (UT2004)#Touch|Teleporter.Touch]]

Teleport modified so that it also changes the location of projectiles.

===Other instance functions===
====IsValidProjectile====
{{code|function [[bool]] '''IsValidProjectile''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

Is the incoming Actor a projectile from the array?

User:Crusha/UltimateMappingTools/ProjectileJumppad

2011-10-13T13:36:01Z

Crusha: First revision of page. Checked for correctness.

by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it
bumps them up as well.

==Properties==
===Property group 'ProjectileJumppad'===
====AllowedProjectiles====
'''Type:''' [[array]]<[[class]]<[[UE2:Projectile (UT2004)|Projectile]]> >

Which projectile classes are allowed. By default are only those allowed for which it makes logically sense to be bounced up and which don't explode on impact.

'''Default value, index 0:''' [[Types#Class|Class]]'[[UE2:Grenade (UT2004)|XWeaponsGrenade]]'

'''Default value, index 1:''' [[Types#Class|Class]]'[[UE2:ONSGrenadeProjectile (UT2004)|OnslaughtONSGrenadeProjectile]]'

'''Default value, index 2:''' [[Types#Class|Class]]'[[UE2:ONSMineProjectile (UT2004)|OnslaughtONSMineProjectile]]'

====bKeepOriginalPath====
'''Type:''' [[bool]]

If True, projectiles are influenced but not completely changed by the Jumppad. Adds more dynamic to the thing and makes it harder to exploit this mechanic.

==Functions==
===Events===
====PostTouch====
{{code|event '''PostTouch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:UTJumpPad (UT2004)#PostTouch|UTJumpPad.PostTouch]]

Adds special handling for projectiles.

====Touch====
{{code|event '''Touch''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:UTJumpPad (UT2004)#Touch|UTJumpPad.Touch]]

Lets also valid projectiles pass the initial check.

===Other instance functions===
====IsValidProjectile====
{{code|function [[bool]] '''IsValidProjectile''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

Returns true if the touching Actor is a projectile class from the array.

User:Crusha/UltimateMappingTools

2011-10-13T13:29:21Z

Crusha: Added a few more Actors.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==ProjectileJumppad==
by Crusha K. Rool
{{infobox class
| class = ProjectileJumppad
| game = UT2004
| engine = UE2
| parent1 = UTJumpPad
| parent2 = JumpPad
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can place grenades on a Jumppad and it bumps them up as well. This lets you specify projectile classes that are bumped the same way as players.

See [[User:Crusha/UltimateMappingTools/ProjectileJumppad|this page]] for more information about this Actor.

==ProjectileTeleporter==
by Crusha K. Rool
{{infobox class
| class = ProjectileTeleporter
| game = UT2004
| engine = UE2
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Got inspired by Quake 4 where you can shoot through teleporters. This won't let instant hit weapons pass, but it's still nice to send rockets in to clear the other side or to shoot them after an enemy.

See [[User:Crusha/UltimateMappingTools/ProjectileTeleporter|this page]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

==VehicleSpawnProtectionTimer==
by Crusha K. Rool
{{infobox class
| class = VehicleSpawnProtectionTimer
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Disables spawn protection for the vehicle after a fixed amount of time after the vehicle was spawned.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/UltimateVCTFFactory

2011-10-13T10:18:23Z

Crusha: First revision of page. Checked for correctness.

by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work.
{{infobox class
| class = UltimateVCTFFactory
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Ultimate Factory for VCTF, giving the mapper more control over vehicle balancing and the functionality of the vehicle itself. Vehicles can be tracked as well, if an [[User:Crusha/UltimateMappingTools/UltimateRadarMap|UltimateRadarMap Actor]] is placed in the map.

==Properties==
===Property group 'Events'===
====PreSpawnEvent====
'''Type:''' [[name]]

Event to trigger before spawn. Not activated when the vehicle was trigger-spawned.

===Property group 'UltimateVCTFFactory'===
====bRandomFlip====
'''Type:''' [[bool]]

Vehicle may be rotated by the AlternativeRotation.

====AlternativeRotation====
'''Type:''' [[int]]

If bRandomFlip, the Vehicle may spawn rotated by this value.

8192 = 45°; 16384 = 90°; 32768 = 180°; etc..
Negative values will rotate in the opposite direction.

====bAutoTeam====
'''Type:''' [[bool]]

Uses the TeamNum of the closest GameObjective.

====bCrushable====
'''Type:''' [[bool]]

Allow spawning over colliding actors.

====bEnabled====
'''Type:''' [[bool]]

Factory is triggered "on" at the beginning.

'''Default value:''' True

====bTriggeredSpawn====
'''Type:''' [[bool]]

If True, this factory will immediately spawn a vehicle when being triggered.

If False, triggering will enable the factory and untriggering will disable it.

====bUniqueVehicle====
'''Type:''' [[bool]]

Factory spawns only a limited number of vehicles, there will be no second one when they are destroyed.
MaxVehicleCount determines the number of vehicles that can be spawned.

====NotLockedForTeam====
'''Type:''' [[byte]]

This will always lock the Vehicles for the TeamNum that is NOT entered here.
255 is normal, 0 will always lock this for Blue, 1 always for Red.

(Hack for Minigun turrets - it makes pretty much only sense to use this with them at the team's Core)

'''Default value:''' 255

====PreSpawnTime====
'''Type:''' [[float]]

Time before spawn to trigger PrepSpawn-Event and -Effect.

'''Default value:''' 2.0

====RetrySpawnTime====
'''Type:''' [[float]]

Interval to wait if spawn area is blocked.

'''Default value:''' 1.0

====TeamNum====
'''Type:''' [[byte]]

0= red, 1= blue, 255= neutral / none

TeamNums are switched automatically on Reset, if necessary. This is primarily used in combination with bIndependentFactory.

====VehicleList====
'''Type:''' [[array]]<{{tl|SpawnedVehicleProperties}}>

List for random vehicle spawn.

====VehicleSelectionType====
'''Type:''' {{tl|EVehicleSelectionType}}

Which method should be used to select the vehicle for spawning.

===Internal variables===
====bInitiallyEnabled====
'''Type:''' [[bool]]

Needed for Reset().

====bPreSpawn====
'''Type:''' [[bool]]

Neither the vehicle or build effect have been spawned yet

====LastSpawned====
'''Type:''' [[UE2:Vehicle (UT2004)|Vehicle]]

The last vehicle that has been spawned.

====RandomArrayNumber====
'''Type:''' [[int]]

For accessing the properties of the individual vehicle

====SequentialArrayNumber====
'''Type:''' [[int]]

Same, but in a sequential order.

====URM====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarMap|UltimateRadarMap]]

The UltimateRadarMap Actor in the map. If none is there, no radar tracking is available.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#DrawType|DrawType]]
| [[UE2:Actor enums (UT2004)#EDrawType|DT_Sprite]]
|}

==Enums==
====ESpawnSize====
The size of the spawneffect particle ring around the vehicle to use.
;SIZE_None :
;SIZE_Scorpion :
;SIZE_Manta :
;SIZE_Raptor :
;SIZE_Hellbender :
;SIZE_Goliath :
;SIZE_Leviathan :

====EVehicleSelectionType====
Which method should be used to select the vehicle for spawning.
; VST_Random : Random from list, equal chances for everyone.
; VST_Probability : Use Probability values of the vehicle, so some vehicles are more likely than others.
; VST_Sequential : Always select the next entry from the list when spawning a new vehicle.
; VST_OnceRandom : Random as above, just that the choice will be used for the whole match.
; VST_OnceProbability : Use Probablity as above, just that the choice will be used for the whole match.

==Structs==
===SpawnedVehicleProperties===
A load of customization and you need to do it for every entry in the list and for red and blue separately. But it pays out.
; [[class]]<[[UE2:Vehicle (UT2004)|Vehicle]]> Vehicle : The vehicle that is spawned with this entry.
; [[int]] Health : Give the spawned Vehicle a custom Health value. 0 will use the Vehicle's default.
; [[float]] SpawnProbability : Used with bUseSpawnProbability. You can enter whatever you like, just the relative difference between the entries counts.
; [[name]] VehicleSpawnedEvent : Tag to be triggered upon spawning of this particular vehicle (additionally to the one of the factory itself). The vehicle will be the instigator.
; [[name]] VehicleDestroyedEvent : Tag to be triggered upon destruction of the vehicle. Vehicle must be a subclass of ONSVehicle for this to happen.
; {{tl|ESpawnSize}} SpawnEffectSize : The size of the spawneffect around the vehicle to use.
; [[bool]] bCanCarryFlag : This vehicle can carry the flag.
; [[bool]] bEjectDriver : Eject driver when vehicle gets destroyed instead of killing him.
; [[bool]] bEnterringDoesNotUnlock : Vehicle is not unlocked when a player enters it.
; [[float]] SpawnProtectionTime : The vehicle is shielded from any damage for this many seconds after spawn (spawn protection is lift immediately when a driver enters). 0 disables this, -1 means the vehicle is protected until someone enters it.
; [[bool]] bChangeMaxDesireability : If True, use a custom MaxDesirability value to tell bots if they should use the vehicle or not.
; [[float]] MaxDesireability : Default values are: Scorpion - 0.4; Hellbender - 0.5; Raptor, Cicada, Manta, SPMA, Paladin - 0.6; Goliath, Ion Tank - 0.8; Leviathan - 2.0. Go figure what matches your vehicle best.
; [[bool]] bTrackVehicleOnRadar : The vehicle's location will be shown in realtime on the RadarMap.
; [[bool]] bRadarVisibleToDriver : Should the vehicle be shown on the radar to it's driver? Only useful if you have a large delay between the updates and want to estimate where your team sees you on the radar.
; [[bool]] bRadarNeutralWhenEmpty : If true, the vehicle is drawn with white team color when it's left.
; [[bool]] bRadarHideWhenEmpty : If true, the vehicle is not drawn when it's empty.
; [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI#ERadarVehicleVisibility|UltimateRadarVehicleLRI.ERadarVehicleVisibility]] RadarVehicleVisibility : Here you set to which players the vehicle is shown on the RadarMap.
; [[float]] RadarOwnerUpdateTime : How many seconds have to pass before the location of vehicle is updated for the owning team.
; [[float]] RadarEnemyUpdateTime : Same as above, just for enemies.
; [[bool]] bRadarFadeWithOwnerUpdateTime : If True, the icon on the radar map will interpolate between opaque and translucent as time passes between location updates on the radar.
; [[bool]] bRadarFadeWithEnemyUpdateTime : If False, the icon will always stay fully opaque.
; [[UE2:Material (UT2004)|Material]] RadarTexture : The texture that represents the vehicle on the radar. It should have an alpha channel and be set to TC_Clamp. A bunch of vehicle textures for the radar are delivered in the texture package that comes with this toolset.
; [[float]] RadarTextureScale : The image will be scaled by this factor.
; [[int]] RadarTextureRotationOffset : The image will be rotated by this (in Rotation Units), in case your texture doesn't face the right way (up is the direction the vehicle is driving to).

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]

Performs a check to notify the mapper if this actor is useless.
References the UltimateRadarMap if it exists.
Sets some inherited variables to the correct values, enables the factory if necessary and precaches all the vehicles in the array.

====PostNetBeginPlay====
{{code|event '''PostNetBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostNetBeginPlay|Actor.PostNetBeginPlay]]

Activates the factory, either according to the closest GameObjective or with a fixed team number.

====Timer====
{{code|event '''Timer''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Timer|Actor.Timer]]

The main function of this actor. It handles when to call which other function.

====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:SVehicleFactory (UT2004)#Trigger|SVehicleFactory.Trigger]]

Either enable or spawn directly if bTriggeredSpawn.

====UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]

Disable if not bTriggeredSpawn.

====VehicleDestroyed====
{{code|event '''VehicleDestroyed''' ([[UE2:Vehicle (UT2004)|Vehicle]] '''V''')}}

'''Overrides:''' [[UE2:SVehicleFactory (UT2004)#VehicleDestroyed|SVehicleFactory.VehicleDestroyed]]

VehicleCount gets reduced (if wished) and the LinkedReplicationInfo for the radar is removed, if one for this vehicle existed.

===Other instance functions===
====Activate====
{{code|function '''Activate''' ([[byte]] '''T''')}}

Activate the Factory.

====ChooseVehicle====
{{code|function '''ChooseVehicle''' ()}}

Sets the VehicleClass to a Vehicle from the currently valid array. The class can be chosen randomly or sequential. In any case is RandomArrayNumber the index of the chosen entry in the array, so that we can find the matching properties for this vehicle when it's spawned.

====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

Adjust this actor if the sides are switched in ONS and deletes all remaining vehicles on the map.

====SpawnBuildEffect====
{{code|function '''SpawnBuildEffect''' ()}}

Spawns the BuildEffect emitter.

====SpawnVehicle====
{{code|function '''SpawnVehicle''' ()}}

Spawns the chosen VehicleClass and applies the properties from the matching entry in the array. The creation of a LinkedReplicationInfo for the radar is also handled here, if necessary.

If the ChooseVehicle function chose an entry with an empty vehicle class, then the Timer is set back to the length of a RespawnTime to try it again.

====UpdatePrecacheMaterials====
{{code|simulated function '''UpdatePrecacheMaterials''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#UpdatePrecacheMaterials|Actor.UpdatePrecacheMaterials]]

Loads all vehicles in the arrays into cache to have fast access during the game.

====VehicleArrayPrecache====
{{code|simulated function '''VehicleArrayPrecache''' ()}}

Loads all vehicles in the arrays into cache to have fast access during the game.

User:Crusha/UltimateMappingTools/UltimateRadarMapMarker

2011-10-13T10:16:33Z

Crusha: First revision of page. Autogenerated.

by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

==Properties==
===Property group 'UltimateRadarMapMarker'===
====bInitiallyEnabled====
'''Type:''' [[bool]]

Is active from the beginning.

====bRadarFadeWithUpdateTime====
'''Type:''' [[bool]]

If True, the icon on the radar map will interpolate between opaque and translucent as time passes between location updates on the radar.

If False, the icon will always stay fully opaque.

====RadarMarkerVisibility====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI#ERadarVehicleVisibility|UltimateRadarVehicleLRI.ERadarVehicleVisibility]]



====RadarMaterial====
'''Type:''' [[UE2:Material (UT2004)|Material]]



====RadarTextureRotationOffset====
'''Type:''' [[int]]

A base rotation that is added to the rotation of the texture.

====RadarTextureScale====
'''Type:''' [[float]]

The image will be scaled by this factor.

====RadarUpdateTime====
'''Type:''' [[float]]



===Internal variables===
====LRI====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI#ERadarVehicleVisibility|UltimateRadarVehicleLRI]]

Reference to the LRI that represents this texture.

====OriginalLocation====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]



====OriginalRotation====
'''Type:''' [[UE2:Object structs (UT2004)#Rotator|Object.Rotator]]



====RadarRI====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateONSFactory#UltimateONSRadarHUDRI|UltimateONSRadarHUDRI]]



====URM====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarMap|UltimateRadarMap]]



==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]



====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]



====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Trigger|Actor.Trigger]]



====UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]



===Other instance functions===
====CreateLRI====
{{code|function '''CreateLRI''' ()}}



====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI

2011-10-13T10:13:19Z

Crusha: First revision of the page. Autogenerated.

=UltimateRadarVehicleLRI=
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}
{{autogenerated}}
ReplicationInfo for a Vehicle from the UltimateONSFactory

Stores the radar-relevant values and updates and replicates the location of vehicle to the client so that it can be read by the UltimateRadarVehicleHUDOverlay.

==Properties==
====bAdded====
'''Type:''' [[bool]]



====bMarkerMode====
'''Type:''' [[bool]]

If True, this is used by the UltimateRadarMapMarker and thus doesn't require a vehicle.

====bRadarFadeWithEnemyUpdateTime====
'''Type:''' [[bool]]

If False, the icon will always stay fully opaque.

====bRadarFadeWithOwnerUpdateTime====
'''Type:''' [[bool]]

If True, the icon on the radar map will interpolate between opaque and translucent as time passes between location updates on the radar.

====bRadarHideWhenEmpty====
'''Type:''' [[bool]]

If true, the vehicle is not drawn when it's empty.

====bRadarNeutralWhenEmpty====
'''Type:''' [[bool]]

If true, the vehicle is drawn with white team color when it's left.

====bRadarVisibleToDriver====
'''Type:''' [[bool]]

Should the vehicle be shown on the radar to it's driver?

====NextVehicleLRI====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|UltimateRadarVehicleLRI]]

The next ReplicationInfo. This way we create a dynamic linked list that can change at runtime.

====OldOwnerTeam====
'''Type:''' [[byte]]

The original TeamNum that the vehicle had.

====PassedTime====
'''Type:''' [[float]]



====PassedTimeEnemy====
'''Type:''' [[float]]

The time that has passed since the location and rotation have been updated.

====RadarEnemyUpdateTime====
'''Type:''' [[float]]

Same as above, just for enemies.

====RadarMaterial====
'''Type:''' [[UE2:Material (UT2004)|Material]]



====RadarOwnerUpdateTime====
'''Type:''' [[float]]

How many seconds have to pass before the location and rotation of the vehicle is updated for the owning team.

====RadarTexRot====
'''Type:''' [[UE2:TexRotator (UT2004)|TexRotator]]

This image will represent the vehicle on the Radar.

====RadarTextureRotationOffset====
'''Type:''' [[int]]

A base rotation that is added to the rotation of the texture.

====RadarTextureScale====
'''Type:''' [[float]]

The image will be scaled by this factor.

====RadarVehicleVisibility====
'''Type:''' {{tl|ERadarVehicleVisibility}}



====TrackedVehicle====
'''Type:''' [[UE2:Vehicle (UT2004)|Vehicle]]

The vehicle whose location and rotation is tracked.

====VehicleLocation====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]



====VehicleLocationEnemy====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]

The location of the vehicle. (replicated)

====VehicleLRIMaster====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI#UltimateRadarVehicleLRIMaster|UltimateRadarVehicleLRIMaster]]



===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#bSkipActorPropertyReplication|bSkipActorPropertyReplication]]
| False
|-
| [[UE2:Actor internal variables (UT2004)#NetPriority|NetPriority]]
| 2.0
|}

==Enums==
====ERadarVehicleVisibility====

; RVV_Always : Always to everyone.
; RVV_DriverTeam : Always to the team that drives the vehicle.
; RVV_DriverEnemy : Always to the enemy team of the driver.
; RVV_OriginalTeam : Always to the team that originally owned the vehicle.
; RVV_OriginalTeamAndHijacker : Always to the team that originally owned the vehicle and to the enemy when he hijacks.
; RVV_OriginalEnemy : Always to the team that not originally owned the vehicle.
; RVV_OriginalEnemyAndHijacker : Always to the team that not originally owned the vehicle and to the owners when it got hijacked.
; RVV_OnlyWhenOwned : Only show to the team that originally owned the vehicle when it's not hijacked.
; RVV_OnlyWhenHijacked : Only show to the team that originally owned the vehicle when it got hijacked.

==Events==
====BaseChange====
{{code|simulated event '''BaseChange''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#BaseChange|Actor.BaseChange]]



====BeginPlay====
{{code|event '''BeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#BeginPlay|Actor.BeginPlay]]



====Destroyed====
{{code|simulated event '''Destroyed''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Destroyed|Actor.Destroyed]]



====PostBeginPlay====
{{code|simulated event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]



====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]



=UltimateRadarVehicleLRIMaster=
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRIMaster
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}
{{autogenerated}}
Master of the UltimateRadarVehicleLRIs

Serves as anchor for the first node in the linked list of UltimateRadarVehicleLRIs.
Contains functions to add or remove new nodes at the correct position in the list.

==Properties==
====FirstVehicleLRI====
'''Type:''' [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|UltimateRadarVehicleLRI]]



===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#NetPriority|NetPriority]]
| 2.0
|}

==Instance functions==
====AddVehicleLRI====
{{code|simulated function '''AddVehicleLRI''' ([[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|UltimateRadarVehicleLRI]] '''VehicleLRI''')}}



====RemoveVehicleLRI====
{{code|simulated function '''RemoveVehicleLRI''' ([[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|UltimateRadarVehicleLRI]] '''U''')}}

User:Crusha/UltimateMappingTools

2011-10-13T10:02:28Z

Crusha: Added a bunch of additional Actors.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more information about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more information about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more information about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more information about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more information about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more information about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more information about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more information about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more information about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more information about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more information about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more information about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more information about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more information about this Actor.

==UltimateRadarMapMarker==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMapMarker
| game = UT2004
| engine = UE2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Draws a texture on the radar map, representing the location and rotation of this Actor.
Can be turned on and off with triggering.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMapMarker|this page]] for more information about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more information about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more information about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more information about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more information about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more information about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more information about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more information about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from this information. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more information about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more information about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more information about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more information about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more information about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more information about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Pickups=
Some additional pickups that mappers can use.

==SuperShockWeaponBase==
{{infobox class
| class = SuperShockWeaponBase
| game = UT2004
| engine = UE2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A simple xWeaponBase that has the SuperShockRifle set in the DefaultProperties
because you can't select it just from the dropdown menu.
Use and place it wisely, nobody likes unfair and frustrating maps. But ONS-BiggerBeerBattle would not nearly as fun and exciting without it.

==MegaShieldPack==
{{infobox class
| class = MegaShieldPack
| game = UT2004
| engine = UE2
| parent1 = SuperShieldPack
| parent2 = ShieldPickup
| parent3 = TournamentPickup
| parent4 = Pickup
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

Provides the player with 150 armor points instead of just 100.
Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

It looks exactly like the SuperShieldPickup, just that it has a dark green shader instead of an orange one.

==UDamagePack_Prolonged==
{{infobox class
| class = UDamagePack_Prolonged
| game = UT2004
| engine = UE2
| parent1 = UDamagePack
| parent2 = TournamentPickup
| parent3 = Pickup
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Lasts 45 seconds instead of just 30 and uses a white-greyish shader for better
distinction. Additionally it's directly placeable in a map, though a
PickupBase is recommended to be used.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more information about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more information about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more information about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more information about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more information about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Misc=
Helper classes that are shared by some scripts. It's not relevant to mappers in any way.

==UltimateMathAux==
by Wormbo & Co.
{{infobox class
| class = UltimateMathAux
| game = UT2004
| engine = UE2
| parent1 = Object
| custom = yes
}}

A very basic class that holds some static auxiliary math functions.

See [[User:Crusha/UltimateMappingTools/UltimateMathAux|this page]] for a full reference.

==UltimateRadarVehicleLRI==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarVehicleLRI
| game = UT2004
| engine = UE2
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A linked list of ReplicationInfos that tell the radar the position of tracked vehicles.

See [[User:Crusha/UltimateMappingTools/UltimateRadarVehicleLRI|this page]] for a full reference.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more information about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/UltimateVCTFFactory

2011-10-13T09:37:03Z

Crusha: First revision of page. Checked for correctness.

by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work.
{{infobox class
| class = UltimateONSFactory
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Ultimate Factory for VCTF, giving the mapper more control over vehicle balancing and the functionality of the vehicle itself. Vehicles can be tracked as well, if an [[User:Crusha/UltimateMappingTools/UltimateRadarMap|UltimateRadarMap Actor]] is placed in the map.

==Properties==
===Property group 'Events'===
====PreSpawnEvent====
'''Type:''' [[name]]

Event to trigger before spawn. Not activated when the vehicle was trigger-spawned.

===Property group 'UltimateVCTFFactory'===
====bRandomFlip====
'''Type:''' [[bool]]

Vehicle may be rotated by the AlternativeRotation.

====AlternativeRotation====
'''Type:''' [[int]]

If bRandomFlip, the Vehicle may spawn rotated by this value.

8192 = 45°; 16384 = 90°; 32768 = 180°; etc..
Negative values will rotate in the opposite direction.

====bAutoTeam====
'''Type:''' [[bool]]

Uses the TeamNum of the closest GameObjective.

====bCrushable====
'''Type:''' [[bool]]

Allow spawning over colliding actors.

====bEnabled====
'''Type:''' [[bool]]

Factory is triggered "on" at the beginning.

'''Default value:''' True

====bTriggeredSpawn====
'''Type:''' [[bool]]

If True, this factory will immediately spawn a vehicle when being triggered.

If False, triggering will enable the factory and untriggering will disable it.

====bUniqueVehicle====
'''Type:''' [[bool]]

Factory spawns only a limited number of vehicles, there will be no second one when they are destroyed.
MaxVehicleCount determines the number of vehicles that can be spawned.

====NotLockedForTeam====
'''Type:''' [[byte]]

This will always lock the Vehicles for the TeamNum that is NOT entered here.
255 is normal, 0 will always lock this for Blue, 1 always for Red.

(Hack for Minigun turrets - it makes pretty much only sense to use this with them at the team's Core)

'''Default value:''' 255

====PreSpawnTime====
'''Type:''' [[float]]

Time before spawn to trigger PrepSpawn-Event and -Effect.

'''Default value:''' 2.0

====RetrySpawnTime====
'''Type:''' [[float]]

Interval to wait if spawn area is blocked.

'''Default value:''' 1.0

====TeamNum====
'''Type:''' [[byte]]

0= red, 1= blue, 255= neutral / none

TeamNums are switched automatically on Reset, if necessary. This is primarily used in combination with bIndependentFactory.

====VehicleList====
'''Type:''' [[array]]<{{tl|SpawnedVehicleProperties}}>

List for random vehicle spawn.

====VehicleSelectionType====
'''Type:''' {{tl|EVehicleSelectionType}}

Which method should be used to select the vehicle for spawning.

===Internal variables===
====bInitiallyEnabled====
'''Type:''' [[bool]]

Needed for Reset().

====bPreSpawn====
'''Type:''' [[bool]]

Neither the vehicle or build effect have been spawned yet

====LastSpawned====
'''Type:''' [[UE2:Vehicle (UT2004)|Vehicle]]

The last vehicle that has been spawned.

====RandomArrayNumber====
'''Type:''' [[int]]

For accessing the properties of the individual vehicle

====SequentialArrayNumber====
'''Type:''' [[int]]

Same, but in a sequential order.

====URM====
'''Type:''' {{cl|UltimateRadarMap}}

The UltimateRadarMap Actor in the map. If none is there, no radar tracking is available.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#DrawType|DrawType]]
| [[UE2:Actor enums (UT2004)#EDrawType|DT_Sprite]]
|}

==Enums==
====ESpawnSize====
The size of the spawneffect particle ring around the vehicle to use.
;SIZE_None :
;SIZE_Scorpion :
;SIZE_Manta :
;SIZE_Raptor :
;SIZE_Hellbender :
;SIZE_Goliath :
;SIZE_Leviathan :

====EVehicleSelectionType====
Which method should be used to select the vehicle for spawning.
; VST_Random : Random from list, equal chances for everyone.
; VST_Probability : Use Probability values of the vehicle, so some vehicles are more likely than others.
; VST_Sequential : Always select the next entry from the list when spawning a new vehicle.
; VST_OnceRandom : Random as above, just that the choice will be used for the whole match.
; VST_OnceProbability : Use Probablity as above, just that the choice will be used for the whole match.

==Structs==
===SpawnedVehicleProperties===
A load of customization and you need to do it for every entry in the list and for red and blue separately. But it pays out.
; [[class]]<[[UE2:Vehicle (UT2004)|Vehicle]]> Vehicle : The vehicle that is spawned with this entry.
; [[int]] Health : Give the spawned Vehicle a custom Health value. 0 will use the Vehicle's default.
; [[float]] SpawnProbability : Used with bUseSpawnProbability. You can enter whatever you like, just the relative difference between the entries counts.
; [[name]] VehicleSpawnedEvent : Tag to be triggered upon spawning of this particular vehicle (additionally to the one of the factory itself). The vehicle will be the instigator.
; [[name]] VehicleDestroyedEvent : Tag to be triggered upon destruction of the vehicle. Vehicle must be a subclass of ONSVehicle for this to happen.
; {{tl|ESpawnSize}} SpawnEffectSize : The size of the spawneffect around the vehicle to use.
; [[bool]] bCanCarryFlag : This vehicle can carry the flag.
; [[bool]] bEjectDriver : Eject driver when vehicle gets destroyed instead of killing him.
; [[bool]] bEnterringDoesNotUnlock : Vehicle is not unlocked when a player enters it.
; [[float]] SpawnProtectionTime : The vehicle is shielded from any damage for this many seconds after spawn (spawn protection is lift immediately when a driver enters). 0 disables this, -1 means the vehicle is protected until someone enters it.
; [[bool]] bChangeMaxDesireability : If True, use a custom MaxDesirability value to tell bots if they should use the vehicle or not.
; [[float]] MaxDesireability : Default values are: Scorpion - 0.4; Hellbender - 0.5; Raptor, Cicada, Manta, SPMA, Paladin - 0.6; Goliath, Ion Tank - 0.8; Leviathan - 2.0. Go figure what matches your vehicle best.
; [[bool]] bTrackVehicleOnRadar : The vehicle's location will be shown in realtime on the RadarMap.
; [[bool]] bRadarVisibleToDriver : Should the vehicle be shown on the radar to it's driver? Only useful if you have a large delay between the updates and want to estimate where your team sees you on the radar.
; [[bool]] bRadarNeutralWhenEmpty : If true, the vehicle is drawn with white team color when it's left.
; [[bool]] bRadarHideWhenEmpty : If true, the vehicle is not drawn when it's empty.
; {{tl|ERadarVehicleVisibility|UltimateRadarVehicleLRI}} RadarVehicleVisibility : Here you set to which players the vehicle is shown on the RadarMap.
; [[float]] RadarOwnerUpdateTime : How many seconds have to pass before the location of vehicle is updated for the owning team.
; [[float]] RadarEnemyUpdateTime : Same as above, just for enemies.
; [[bool]] bRadarFadeWithOwnerUpdateTime : If True, the icon on the radar map will interpolate between opaque and translucent as time passes between location updates on the radar.
; [[bool]] bRadarFadeWithEnemyUpdateTime : If False, the icon will always stay fully opaque.
; [[UE2:Material (UT2004)|Material]] RadarTexture : The texture that represents the vehicle on the radar. It should have an alpha channel and be set to TC_Clamp. A bunch of vehicle textures for the radar are delivered in the texture package that comes with this toolset.
; [[float]] RadarTextureScale : The image will be scaled by this factor.
; [[int]] RadarTextureRotationOffset : The image will be rotated by this (in Rotation Units), in case your texture doesn't face the right way (up is the direction the vehicle is driving to).

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]

Performs a check to notify the mapper if this actor is useless.
References the UltimateRadarMap if it exists.
Sets some inherited variables to the correct values, enables the factory if necessary and precaches all the vehicles in the array.

====PostNetBeginPlay====
{{code|event '''PostNetBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostNetBeginPlay|Actor.PostNetBeginPlay]]

Activates the factory, either according to the closest GameObjective or with a fixed team number.

====Timer====
{{code|event '''Timer''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Timer|Actor.Timer]]

The main function of this actor. It handles when to call which other function.

====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:SVehicleFactory (UT2004)#Trigger|SVehicleFactory.Trigger]]

Either enable or spawn directly if bTriggeredSpawn.

====UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]

Disable if not bTriggeredSpawn.

====VehicleDestroyed====
{{code|event '''VehicleDestroyed''' ([[UE2:Vehicle (UT2004)|Vehicle]] '''V''')}}

'''Overrides:''' [[UE2:SVehicleFactory (UT2004)#VehicleDestroyed|SVehicleFactory.VehicleDestroyed]]

VehicleCount gets reduced (if wished) and the LinkedReplicationInfo for the radar is removed, if one for this vehicle existed.

===Other instance functions===
====Activate====
{{code|function '''Activate''' ([[byte]] '''T''')}}

Activate the Factory.

====ChooseVehicle====
{{code|function '''ChooseVehicle''' ()}}

Sets the VehicleClass to a Vehicle from the currently valid array. The class can be chosen randomly or sequential. In any case is RandomArrayNumber the index of the chosen entry in the array, so that we can find the matching properties for this vehicle when it's spawned.

====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

Adjust this actor if the sides are switched in ONS and deletes all remaining vehicles on the map.

====SpawnBuildEffect====
{{code|function '''SpawnBuildEffect''' ()}}

Spawns the BuildEffect emitter.

====SpawnVehicle====
{{code|function '''SpawnVehicle''' ()}}

Spawns the chosen VehicleClass and applies the properties from the matching entry in the array. The creation of a LinkedReplicationInfo for the radar is also handled here, if necessary.

If the ChooseVehicle function chose an entry with an empty vehicle class, then the Timer is set back to the length of a RespawnTime to try it again.

====UpdatePrecacheMaterials====
{{code|simulated function '''UpdatePrecacheMaterials''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#UpdatePrecacheMaterials|Actor.UpdatePrecacheMaterials]]

Loads all vehicles in the arrays into cache to have fast access during the game.

====VehicleArrayPrecache====
{{code|simulated function '''VehicleArrayPrecache''' ()}}

Loads all vehicles in the arrays into cache to have fast access during the game.

User:Crusha/UltimateMappingTools/EnhancedLevelGameRules

2011-10-12T22:03:22Z

Crusha: First revision of page. Checked for correctness.

Original code idea by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map, even if the server has chosen them.

For instance if you map would be exploited with the Stunt Mutator, you can disable it here completely.

==Properties==
===Property group 'EnhancedLevelGameRules'===
====NotAllowedMutator====
'''Type:''' [[array]]<[[name]]>

The class name of the Mutator that you want to forbid.

==Instance functions==
====UpdateGame====
{{code|function '''UpdateGame''' ([[UE2:GameInfo (UT2004)|GameInfo]] '''G''')}}

'''Overrides:''' [[UE2:LevelGameRules (UT2004)#UpdateGame|LevelGameRules.UpdateGame]]

Iterate the Mutator list and check if there is a Mutator that we want to forbid. IsA(*Array Entry*) will be used to check for them. Mutators with GroupName "Security" are left alone, although really crucial ones won't even bother about that.

User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment

2011-10-12T21:58:32Z

Crusha: First revision of page, Checked for correctness.

=UltimateDestroyableEnvironment=
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Allows to set up an actor that gets more and more destroyed when it takes
damage. That is done by having multiple versions of the StaticMesh that are
differently high damaged.

==Properties==
===Property group 'Events'===
====ResetEvent====
'''Type:''' [[name]]

Triggered if bReset is True, so that you can potentially do some updates on other things as well when resetting this actor.

====WrongDamageTypeEvent====
'''Type:''' [[name]]

Triggered when an invalid DamageType damaged this actor.

===Property group 'UltimateDestroyableEnvironment'===
====bBlackList====
'''Type:''' [[bool]]

If true, the DamageTypes in the array can NOT damage this actor.

'''Default value:''' True

====bReset====
'''Type:''' [[bool]]

Reset this actor after the round ended or keep destruction the whole match?

====bResetEventOnlyWhenFinalDestruction====
'''Type:''' [[bool]]

If True, only fire off the ResetEvent if an LOD with bFinalDestruction has been reached in this round.

====DamageTypes====
'''Type:''' [[array]]<[[class]]<[[UE2:DamageType (UT2004)|DamageType]]> >

Which DamageTypes can affect this actor?

====LevelOfDestruction====
'''Type:''' [[array]]<{{tl|_LevelOfDestruction}}>

Determines the appearance of the Actor at different health levels.

====TotalHealth====
'''Type:''' [[int]]

The initial health of this actor.

'''Default value:''' 2000

====WrongDamageEventTreshold====
'''Type:''' [[int]]

Trigger an event every time this much damage has been caused by a "wrong" DamageType.

'''Default value:''' 300

===Internal variables===
====AccumulatedWrongDamage====
'''Type:''' [[int]]

This much of the wrong damage has been accumulated already.

====bFinalDestructionReached====
'''Type:''' [[bool]]

Used by bResetEventOnlyWhenFinalDestruction.

====CurrentLOD====
'''Type:''' [[int]]

This tells players who join the match in progress how the Actor currently looks like.

'''Default value:''' -1

====i_temp====
'''Type:''' [[int]]

Counter.

====j_temp====
'''Type:''' [[int]]

Remember the current array for use in GainedChild.

====OldLOD====
'''Type:''' [[int]]

Only change appearance if we receive a LOD value that is not the same as the old one.

'''Default value:''' -1

====OriginalLocation====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]

Remember for calculating offset from default in each LOD.

====OriginalRotation====
'''Type:''' [[UE2:Object structs (UT2004)#Rotator|Object.Rotator]]

Remember for calculating rotation offset from default in each LOD.

====OriginalScale====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]

Just remember this too.

====OriginalStaticMesh====
'''Type:''' {{cl|StaticMesh}}

Remember for reset.

====OriginalStyle====
'''Type:''' [[UE2:Actor enums (UT2004)#ERenderStyle|Actor.ERenderStyle]]

Don't ask.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#bAlwaysRelevant|bAlwaysRelevant]]
| True
|-
| [[UE2:Actor properties (UT2004)#bBlockActors|bBlockActors]]
| True
|-
| [[UE2:Actor properties (UT2004)#bBlockKarma|bBlockKarma]]
| True
|-
| [[UE2:Actor properties (UT2004)#bCollideActors|bCollideActors]]
| True
|-
| [[UE2:Actor properties (UT2004)#bEdShouldSnap|bEdShouldSnap]]
| True
|-
| [[UE2:Actor internal variables (UT2004)#bNetNotify|bNetNotify]]
| True
|-
| [[UE2:Actor properties (UT2004)#bNoDelete|bNoDelete]]
| True
|-
| [[UE2:Actor internal variables (UT2004)#bStatic|bStatic]]
| False
|-
| [[UE2:Actor internal variables (UT2004)#bWorldGeometry|bWorldGeometry]]
| True
|-
| [[UE2:Actor properties (UT2004)#DrawType|DrawType]]
| [[UE2:Actor enums (UT2004)#EDrawType|DT_StaticMesh]]
|-
| [[UE2:Actor internal variables (UT2004)#RemoteRole|RemoteRole]]
| [[UE2:Actor enums (UT2004)#ENetRole|ROLE_SimulatedProxy]]
|-
| [[UE2:Actor properties (UT2004)#StaticMesh|StaticMesh]]
| {{cl|StaticMesh}}'Albatross_architecture.Alb_crate1'
|}

==Structs==
===_DecoKActor===
You can spawn real chunks that are physics calculated when you destroy this Actor step by step.
; {{cl|StaticMesh}} KActorStaticMesh : This StaticMesh will be used by the KarmaThing that is spawned.
; [[float]] KActorMaxNetUpdateInterval : How often is the KActor maximally updated per second for online games. Should be about 0.5
; [[UE2:KarmaParams (UT2004)|KarmaParams]] KActorParameters : Set the parameters for the new Karma object.
; [[UE2:Object structs (UT2004)#Vector|Object.Vector]] SpawnOffset : Where does the KActor spawn in relation to the location of the StaticMesh?
; [[UE2:Object structs (UT2004)#Rotator|Object.Rotator]] RotationOffset : Which rotation does the KActor have in relation to the StaticMesh?
; [[float]] KActorLifeSpan : 

===_LevelOfDestruction===
Determines the appearance of the Actor at different health levels.
; {{cl|StaticMesh}} DestroyedStaticMesh : The new StaticMesh that is used at this LOD.
; [[int]] HealthLimit : This LOD becomes active if the actors health drops below this.
; [[UE2:Object structs (UT2004)#Vector|Object.Vector]] StaticMeshScale : Scale the StaticMesh by this value. Values close to 0 are ignored.
; [[UE2:Object structs (UT2004)#Vector|Object.Vector]] StaticMeshOffset : New location of the StaticMesh in relation to the original location.
; [[UE2:Object structs (UT2004)#Rotator|Object.Rotator]] StaticMeshRotation : New rotation of the StaticMesh in relation to the original rotation.
; [[array]]<{{tl|_DecoKActor}}> KarmaDeco : KActors to spawn at the destruction.
; [[name]] TriggerEvent : Trigger this Event once this LOD has been reached.
; [[bool]] bFinalDestruction : 
; [[bool]] bReached : True if this LOD has been executed already.

==Functions==
===Events===
====GainedChild====
{{code|simulated event '''GainedChild''' ([[UE2:Actor (UT2004)|Actor]] '''Other''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#GainedChild|Actor.GainedChild]]

This is the only place where we can assign our custom KParam as KParam of the spawned KActor before the Karma physics are initilizing.

====PostBeginPlay====
{{code|simulated event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]

Use the Health variable and keep TotalHealth as backup.

====PostNetReceive====
{{code|simulated event '''PostNetReceive''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostNetReceive|Actor.PostNetReceive]]

This updates the visuals and collision on the client to the current LOD when the variable changes on the server or when the player just joined.

====TakeDamage====
{{code|event '''TakeDamage''' ([[int]] '''NDamage''', [[UE2:Pawn (UT2004)|Pawn]] '''instigatedBy''', [[UE2:Object structs (UT2004)#Vector|Object.Vector]] '''hitlocation''', [[UE2:Object structs (UT2004)#Vector|Object.Vector]] '''momentum''', [[class]]<[[UE2:DamageType (UT2004)|DamageType]]> '''damageType''')}}

'''Overrides:''' [[UE2:Decoration (UT2004)#TakeDamage|Decoration.TakeDamage]]

Process damage on this actor and change it's appearance if a DamageLimit is reached.

====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Decoration (UT2004)#Trigger|Decoration.Trigger]]

Triggering will cause the actor to lose all health that is the difference to the next lower LOD, i.e. cause it to active the next LOD.

===Other instance functions===
====AssignKarmaThingProperties====
{{code|simulated function '''AssignKarmaThingProperties''' ([[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment#DynamicSpawnableKarmaThing|DynamicSpawnableKarmaThing]] '''KarmaThing''', [[float]] '''NewLifeSpan''', {{cl|StaticMesh}} '''NewStaticMesh''', [[float]] '''NewMaxNetUpdateInterval''')}}

Small hack to get the KarmaThing set up on the client as well.

====CheckDamageType====
{{code|function [[bool]] '''CheckDamageType''' ([[class]]<[[UE2:DamageType (UT2004)|DamageType]]> '''DT''')}}

Returns True if the DamageType is considered valid for this actor.

====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

Restore initial values if this actor should be reset.

====UpdatePrecacheStaticMeshes====
{{code|simulated function '''UpdatePrecacheStaticMeshes''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#UpdatePrecacheStaticMeshes|Actor.UpdatePrecacheStaticMeshes]]

Load StaticMeshes into memory for faster access.

=DynamicSpawnableKarmaThing=
{{infobox class
| class = DynamicSpawnableKarmaThing
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| customparent1 = KarmaThing
| parent2 = KActor
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A dynamic (and not so network efficient) version of the KarmaThing that can
be spawned at runtime. It's used by the UltimateDestroyableEnvironment and
not supposed to be placed in the map by hand.

==Default values==
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#bNoDelete|bNoDelete]]
| False
|}

User:Crusha/UltimateMappingTools/UltimateONSFactory

2011-10-12T21:44:58Z

Crusha: First revision of page. Checked for correctness.

=UltimateONSFactory=
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work.
{{infobox class
| class = UltimateONSFactory
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail. Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially. Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

==Properties==
===Property group 'Events'===
====PreSpawnEvent====
'''Type:''' [[name]]

Event to trigger before spawn. Not activated when the vehicle was trigger-spawned.

===Property group 'ONSVehicleFactory'===
====BlueTeamRotation====
'''Type:''' [[int]]

If bReverseBlueTeamDirection, the Vehicle will not turn by 180 degrees but by this value.

8192 = 45°; 16384 = 90°; 32768 = 180°; etc..
Negative values will rotate in the opposite direction.

===Property group 'UltimateONSFactory'===
====bCrushable====
'''Type:''' [[bool]]

Allow spawning over colliding actors.

====bEnabled====
'''Type:''' [[bool]]

Factory is triggered "on" at the beginning.

'''Default value:''' True

====bIndependentFactory====
'''Type:''' [[bool]]

PowerNode has no influence on the factory's activity or team number.

====bRandomFlip====
'''Type:''' [[bool]]

Neutral vehicles may face in BlueTeamRotation.

====bTriggeredSpawn====
'''Type:''' [[bool]]

If True, this factory will immediately spawn a vehicle when being triggered.

If False, triggering will enable the factory and untriggering will disable it.

====bUniqueVehicle====
'''Type:''' [[bool]]

Factory spawns only a limited number of vehicles, there will be no second one when they are destroyed.
MaxVehicleCount determines the number of vehicles that can be spawned.

====bUseStaticTeams====
'''Type:''' [[bool]]

Factory works only for one team.

====NotLockedForTeam====
'''Type:''' [[byte]]

This will always lock the Vehicles for the TeamNum that is NOT entered here.
255 is normal ONS, 0 will always lock this for Blue, 1 always for Red.

(Hack for Minigun turrets - it makes pretty much only sense to use this with them at the team's Core)

'''Default value:''' 255

====PreSpawnTime====
'''Type:''' [[float]]

Time before spawn to trigger PrepSpawn-Event and -Effect.

'''Default value:''' 2.0

====RetrySpawnTime====
'''Type:''' [[float]]

Interval to wait if spawn area is blocked.

'''Default value:''' 1.0

====StaticTeamNum====
'''Type:''' [[byte]]

0= red, 1= blue, 255= neutral / none

TeamNums are switched automatically on Reset, if necessary. This is primarily used in combination with bIndependentFactory.

====VehicleListBlue====
'''Type:''' [[array]]<{{tl|SpawnedVehicleProperties}}>

List for random vehicle spawn if blue has the factory

====VehicleListRed====
'''Type:''' [[array]]<{{tl|SpawnedVehicleProperties}}>

List for random vehicle spawn if red or neutral has the factory

====VehicleSelectionType====
'''Type:''' {{tl|EVehicleSelectionType}}

Which method should be used to select the vehicle for spawning.

===Internal variables===
====bInitiallyEnabled====
'''Type:''' [[bool]]

Needed for Reset().

====RadarRI====
'''Type:''' {{cl|UltimateONSRadarHUDRI}}

Takes care of spawning the HUDOverlay on the client.

====RandomArrayNumber====
'''Type:''' [[int]]

For accessing the properties of the individual vehicle

====SequentialArrayNumberRed====
'''Type:''' [[int]]

Same, but in a sequential order.

====SequentialArrayNumberBlue====
'''Type:''' [[int]]

Need seperate ones for Red and Blue.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#DrawType|DrawType]]
| [[UE2:Actor enums (UT2004)#EDrawType|DT_Sprite]]
|}

==Enums==
====ESpawnSize====
The size of the spawneffect particle ring around the vehicle to use.
;SIZE_None :
;SIZE_Scorpion :
;SIZE_Manta :
;SIZE_Raptor :
;SIZE_Hellbender :
;SIZE_Goliath :
;SIZE_Leviathan :

====EVehicleSelectionType====
Which method should be used to select the vehicle for spawning.
; VST_Random : Random from list, equal chances for everyone.
; VST_Probability : Use Probability values of the vehicle, so some vehicles are more likely than others.
; VST_Sequential : Always select the next entry from the list when spawning a new vehicle.
; VST_OnceRandom : Random as above, just that the choice will be used for the whole match.
; VST_OnceProbability : Use Probablity as above, just that the choice will be used for the whole match.

==Structs==
===SpawnedVehicleProperties===
A load of customization and you need to do it for every entry in the list and for red and blue separately. But it pays out.
; [[class]]<[[UE2:Vehicle (UT2004)|Vehicle]]> Vehicle : The vehicle that is spawned with this entry.
; [[int]] Health : Give the spawned Vehicle a custom Health value. 0 will use the Vehicle's default.
; [[float]] SpawnProbability : Used with bUseSpawnProbability. You can enter whatever you like, just the relative difference between the entries counts.
; [[name]] VehicleSpawnedEvent : Tag to be triggered upon spawning of this particular vehicle (additionally to the one of the factory itself). The vehicle will be the instigator.
; [[name]] VehicleDestroyedEvent : Tag to be triggered upon destruction of the vehicle. Vehicle must be a subclass of ONSVehicle for this to happen.
; {{tl|ESpawnSize}} SpawnEffectSize : The size of the spawneffect around the vehicle to use.
; [[bool]] bEjectDriver : Eject driver when vehicle gets destroyed instead of killing him.
; [[bool]] bEnterringDoesNotUnlock : Vehicle is not unlocked when a player enters it.
; [[float]] SpawnProtectionTime : The vehicle is shielded from any damage for this many seconds after spawn (spawn protection is lift immediately when a driver enters). 0 disables this, -1 means the vehicle is protected until someone enters it.
; [[bool]] bChangeMaxDesireability : If True, use a custom MaxDesirability value to tell bots if they should use the vehicle or not.
; [[float]] MaxDesireability : Default values are: Scorpion - 0.4; Hellbender - 0.5; Raptor, Cicada, Manta, SPMA, Paladin - 0.6; Goliath, Ion Tank - 0.8; Leviathan - 2.0. Go figure what matches your vehicle best.
; [[bool]] bTrackVehicleOnRadar : The vehicle's location will be shown in realtime on the RadarMap.
; [[bool]] bRadarVisibleToDriver : Should the vehicle be shown on the radar to it's driver? Only useful if you have a large delay between the updates and want to estimate where your team sees you on the radar.
; [[bool]] bRadarNeutralWhenEmpty : If true, the vehicle is drawn with white team color when it's left.
; [[bool]] bRadarHideWhenEmpty : If true, the vehicle is not drawn when it's empty.
; {{tl|ERadarVehicleVisibility|UltimateRadarVehicleLRI}} RadarVehicleVisibility : Here you set to which players the vehicle is shown on the RadarMap.
; [[float]] RadarOwnerUpdateTime : How many seconds have to pass before the location of vehicle is updated for the owning team.
; [[float]] RadarEnemyUpdateTime : Same as above, just for enemies.
; [[bool]] bRadarFadeWithOwnerUpdateTime : If True, the icon on the radar map will interpolate between opaque and translucent as time passes between location updates on the radar.
; [[bool]] bRadarFadeWithEnemyUpdateTime : If False, the icon will always stay fully opaque.
; [[UE2:Material (UT2004)|Material]] RadarTexture : The texture that represents the vehicle on the radar. It should have an alpha channel and be set to TC_Clamp. A bunch of vehicle textures for the radar are delivered in the texture package that comes with this toolset.
; [[float]] RadarTextureScale : The image will be scaled by this factor.
; [[int]] RadarTextureRotationOffset : The image will be rotated by this (in Rotation Units), in case your texture doesn't face the right way (up is the direction the vehicle is driving to).

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#PostBeginPlay|ONSVehicleFactory.PostBeginPlay]]

Performs a check to notify the mapper if this actor is useless.
References the one and only VehicleLRIMaster in the map. If it doesn't exist yet, a new one is spawned.
Sets some inherited variables to the correct values, enables the factory if necessary and precaches all the vehicles in the array.

====PostNetBeginPlay====
{{code|event '''PostNetBeginPlay''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#PostNetBeginPlay|ONSVehicleFactory.PostNetBeginPlay]]

Activates the factory, either according to the closest ONSPowerNode (uses super function) or with a fixed team number, making the factory effectively independent from a PowerNode.

====SetInitialState====
{{code|event '''SetInitialState''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#SetInitialState|Actor.SetInitialState]]

Remove this factory from the PowerCore's dynamic 'CloseActors'-array.
By doing this, destroying the closest Node will no longer disable this factory.
Executing at this point makes sure that the PostNetBeginPlay() of the PowerCore has been called already.

====Timer====
{{code|event '''Timer''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Timer|ONSVehicleFactory.Timer]]

The main function of this actor. It handles when to call which other function.

====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Trigger|ONSVehicleFactory.Trigger]]

Either enable or spawn directly if bTriggeredSpawn.

====UnTrigger====
{{code|event '''UnTrigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#UnTrigger|Actor.UnTrigger]]

Disable if not bTriggeredSpawn.

====VehicleDestroyed====
{{code|event '''VehicleDestroyed''' ([[UE2:Vehicle (UT2004)|Vehicle]] '''V''')}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#VehicleDestroyed|ONSVehicleFactory.VehicleDestroyed]]

VehicleCount gets reduced (if wished) and the LinkedReplicationInfo for the radar is removed, if one for this vehicle existed.

===Other instance functions===
====Activate====
{{code|function '''Activate''' ([[byte]] '''T''')}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Activate|ONSVehicleFactory.Activate]]

Activation depending on close Nodes.

====ChooseVehicle====
{{code|function '''ChooseVehicle''' ()}}

Sets the VehicleClass to a Vehicle from the currently valid array. The class can be chosen randomly or sequential. In any case is RandomArrayNumber the index of the chosen entry in the array, so that we can find the matching properties for this vehicle when it's spawned.

====Deactivate====
{{code|function '''Deactivate''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#Deactivate|ONSVehicleFactory.Deactivate]]

Deactivation depending on close Nodes.

====Reset====
{{code|function '''Reset''' ()}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#Reset|Actor.Reset]]

Adjust this actor if the sides are switched in ONS and deletes all remaining vehicles on the map.

====SidesAreSwitched====
{{code|function [[bool]] '''SidesAreSwitched''' ()}}

Just to make the code more surveillable.

====SpawnBuildEffect====
{{code|function '''SpawnBuildEffect''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#SpawnBuildEffect|ONSVehicleFactory.SpawnBuildEffect]]

Spawns the BuildEffect emitter.

====SpawnVehicle====
{{code|function '''SpawnVehicle''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#SpawnVehicle|ONSVehicleFactory.SpawnVehicle]]

Spawns the chosen VehicleClass and applies the properties from the matching entry in the array. The creation of a LinkedReplicationInfo for the radar is also handled here, if necessary.

If the ChooseVehicle function chose an entry with an empty vehicle class, then the Timer is set back to the length of a RespawnTime to try it again.

====UpdatePrecacheMaterials====
{{code|simulated function '''UpdatePrecacheMaterials''' ()}}

'''Overrides:''' [[UE2:ONSVehicleFactory (UT2004)#UpdatePrecacheMaterials|ONSVehicleFactory.UpdatePrecacheMaterials]]

Loads all vehicles in the arrays into cache to have fast access during the game.

====VehicleArrayPrecache====
{{code|simulated function '''VehicleArrayPrecache''' ()}}

Loads all vehicles in the arrays into cache to have fast access during the game.

=UltimateONSRadarHUDRI=
{{infobox class
| class = UltimateONSRadarHUDRI
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = ReplicationInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| custom = yes
}}
{{autogenerated}}

Creates the HUDOverlay for the Ultimate ONS radar map. For the vehicle stuff
and so on.

==Properties==
====bCreatedOverlay====
'''Type:''' [[bool]]



====bRadarMutatorEnabled====
'''Type:''' [[bool]]

Disable radar functionality in that case.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#NetUpdateFrequency|NetUpdateFrequency]]
| 1.0
|}

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]



====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]



===Other instance functions===
====HasRadarMutator====
{{code|function [[bool]] '''HasRadarMutator''' ()}}



====HealDamage====
{{code|function [[bool]] '''HealDamage''' ([[int]] '''Amount''', [[UE2:Controller (UT2004)|Controller]] '''Healer''', [[class]]<[[UE2:DamageType (UT2004)|DamageType]]> '''DamageType''')}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#HealDamage|Actor.HealDamage]]



=UltimateRadarVehicleHUDOverlay=
{{infobox class
| class = UltimateRadarVehicleHUDOverlay
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = HudOverlay
| parent2 = Actor
| parent3 = Object
| custom = yes
}}
{{autogenerated}}
HUDOverlay for UltimateONSFactory

This Overlay displays the location of a Vehicle on the RadarMap in realtime.

==Properties==
====ONSHUD====
'''Type:''' [[UE2:ONSHUDOnslaught (UT2004)|ONSHUDOnslaught]]



====OnsIconScale====
'''Type:''' [[float]]



====PCOwner====
'''Type:''' [[UE2:PlayerController (UT2004)|PlayerController]]



====RadarPosX====
'''Type:''' [[float]]



====RadarPosY====
'''Type:''' [[float]]



====RadarRange====
'''Type:''' [[float]]



====RadarScale====
'''Type:''' [[float]]



====RadarTrans====
'''Type:''' [[float]]



====VehicleLRIMaster====
'''Type:''' {{cl|UltimateRadarVehicleLRIMaster}}



==Functions==
===Events===
====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]



===Other instance functions===
====bDrawRadar====
{{code|simulated function [[bool]] '''bDrawRadar''' ()}}



====DrawRadar====
{{code|simulated function '''DrawRadar''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''', [[float]] '''CenterRadarPosX''', [[float]] '''CenterRadarPosY''', [[float]] '''RadarWidth''', [[UE2:Object structs (UT2004)#Vector|Object.Vector]] '''MapCenter''')}}



====Render====
{{code|simulated function '''Render''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''')}}

'''Overrides:''' [[UE2:HudOverlay (UT2004)#Render|HudOverlay.Render]]

User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo

2011-10-12T21:14:25Z

Crusha: First revision of page. Checked for correctness.

by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

ParallaxSkyZoneInfo. Place this instead of a SkyZoneInfo in the skybox.

==Properties==
===Property group 'ParallaxSkyZoneInfo'===
====SkyBoxRelativeOffset====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]



====SkyScale====
'''Type:''' [[float]]

The SkyZoneInfo is moved around relative to the player's location in the map. With this value do you scale how much movement is applied. You need to experiment with the value as it depends on the size of your map and skybox.

'''Default value:''' 0.0625

===Internal variables===
====MyMover====
'''Type:''' {{cl|ParallaxSkyboxMover}}

The ClientMover that moves the SkyZoneInfo around.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor internal variables (UT2004)#bStatic|bStatic]]
| False
|-
| [[UE2:Actor internal variables (UT2004)#RemoteRole|RemoteRole]]
| [[UE2:Actor enums (UT2004)#ENetRole|ROLE_None]]
|-
| [[UE2:Actor properties (UT2004)#Texture|Texture]]
| [[UE2:Texture (UT2004)|Texture]]'UltimateMappingTools_Tex.Icons.ParallaxSkyZone_Icon'
|}

==Events==
====PostBeginPlay====
{{code|simulated event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]

Create the SkyBoxMover and tell him what to do.

by Party Boy
{{infobox class
| class = ParallaxSkyboxMover
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

SkyboxMover for the ParralaxSkyZoneInfo.

==Properties==
====CachedPlayer====
'''Type:''' [[UE2:PlayerController (UT2004)|PlayerController]]

The local PlayerController.

====MovingSky====
'''Type:''' [[UE2:Actor (UT2004)|Actor]]

The ParallaxSkyZoneInfo that we are moving.

====Offset====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]



====Scale====
'''Type:''' [[float]]

The SkyZoneInfo is moved around relative to the player's location in the map. With this value do you scale how much movement is applied. You need to experiment with the value as it depends on the size of your map and skybox.

==Events==
====Tick====
{{code|simulated event '''Tick''' ([[float]] '''Delta''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]

Move the SkyZoneInfo to the new location relative to the player's location in the map.

User:Crusha/UltimateMappingTools/UltimateRadarMap

2011-10-12T21:04:11Z

Crusha: Added related helper classes with autogenerated descriptions.

{{infobox class
| class = UltimateRadarMap
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

==Properties==
===Property group 'UltimateRadarMap'===
====bShowOwnObjectiveCarrier====
'''Type:''' [[bool]]

Shows the location of the own flag/bomb carrier (i.e. your teammember that stole the enemy flag) on radar.

'''Default value:''' True

====bShowEnemyObjectiveCarrier====
'''Type:''' [[bool]]

Shows the location of the enemy flag/bomb carrier on radar.

====bShowNonClassifiedGameObjectives====
'''Type:''' [[bool]]

Shows GameObjectives on the radar that are neither Flags, nor DomintationPoints, nor Bombs, nor BombDeliveries.
I.e. Assault Objectives.

'''Default value:''' True

====bUseActorLocationAsMapCenter====
'''Type:''' [[bool]]

If true, the map center is not assumed to be at 0,0,0 but at the location of this Actor.
This way you don't have to adjust the entire rest of your map to match the center of the editor.

'''Default value:''' True

===Internal variables===
====bAddedOverlay====
'''Type:''' [[bool]]

The HUDOverlay has been added by Tick() already.

====bDisabled====
'''Type:''' [[bool]]

Some Mutator wants us disabled, so we obey.

====bHasRadarVehicles====
'''Type:''' [[bool]]

If no UltimateVehicleFactories are in the match or none of them has a vehicle that should be shown on the radar, we can tell the HUDOverlay to save some performance by skipping that check.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| [[UE2:Actor properties (UT2004)#bNoDelete|bNoDelete]]
| True
|-
| [[UE2:Actor internal variables (UT2004)#NetUpdateFrequency|NetUpdateFrequency]]
| 1.0
|-
| [[UE2:Actor internal variables (UT2004)#RemoteRole|RemoteRole]]
| [[UE2:Actor enums (UT2004)#ENetRole|ROLE_SimulatedProxy]]
|}

==Functions==
===Events===
====BeginPlay====
{{code|event '''BeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#BeginPlay|Actor.BeginPlay]]

Check for Radar Mutators and disable us if one is found or if we are in an ONS map since that one already has a radar map.

====PostBeginPlay====
{{code|simulated event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]

Check if there are vehicles that should be tracked on the radar.

====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]

Used on clients to spawn the HUDOverlay.

===Other instance functions===
====HealDamage====
{{code|function [[bool]] '''HealDamage''' ([[int]] '''Amount''', [[UE2:Controller (UT2004)|Controller]] '''Healer''', [[class]]<[[UE2:DamageType (UT2004)|DamageType]]> '''DamageType''')}}

'''Overrides:''' [[UE2:Actor instance functions (UT2004)#HealDamage|Actor.HealDamage]]

Hack:

If some Mutator knows about us but doesn't want to deal with our variables and functions in particular because he doesn't want to compile us with him, he can use this method.

By calling this very basic function that exists in the Actor class, he can use a plain A.IsA('UltimateRadarMap') and then A.HealDamage() to disable the radar stuff.

I simply assume that no code out there would ever attempt to heal damage on an unknown Info class for whatever reason. But to be absolutely sure, the Amount must be less than 0. ;)

It's recommend to make this happen before PostBeginPlay().

====MutatorCheck====
{{code|function [[bool]] '''MutatorCheck''' ()}}

Returns True if a loaded Mutator affects the radar and thus we should rather disable ourselves. It is only checked if "Radar" is in the GroupName of the Mutator.

{{infobox class
| class = UltimateRadarMapHUDOverlay
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = HudOverlay
| parent2 = Actor
| parent3 = Object
| custom = yes
}}
{{autogenerated}}

Shows the Radar Map in the player's HUD.

==Properties==
====bMapDisabled====
'''Type:''' [[bool]]

Can be toggled by the player.

====bShowEnemyObjectiveCarrier====
'''Type:''' [[bool]]



====bShowNonClassifiedGameObjectives====
'''Type:''' [[bool]]



====bShowOwnObjectiveCarrier====
'''Type:''' [[bool]]



====bTrackVehiclesOnRadar====
'''Type:''' [[bool]]



====IconScale====
'''Type:''' [[float]]



====MapCenterLocation====
'''Type:''' [[UE2:Object structs (UT2004)#Vector|Object.Vector]]



====Objectives====
'''Type:''' [[array]]<[[UE2:GameObjective (UT2004)|GameObjective]]>



====PCOwner====
'''Type:''' [[UE2:PlayerController (UT2004)|PlayerController]]



====RadarPosX====
'''Type:''' [[float]]



====RadarPosY====
'''Type:''' [[float]]



====RadarRange====
'''Type:''' [[float]]



====RadarScale====
'''Type:''' [[float]]



====RadarTrans====
'''Type:''' [[float]]



====VehicleLRIMaster====
'''Type:''' {{cl|UltimateRadarVehicleLRIMaster}}

The manager of all radar-related vehicle replication. There should be only one at a time.

==Functions==
===Events===
====BeginPlay====
{{code|simulated event '''BeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#BeginPlay|Actor.BeginPlay]]



====PostBeginPlay====
{{code|simulated event '''PostBeginPlay''' ()}}

'''Overrides:''' [[UE2:Actor events (UT2004)#PostBeginPlay|Actor.PostBeginPlay]]



====Tick====
{{code|simulated event '''Tick''' ([[float]] '''DeltaTime''')}}

'''Overrides:''' [[UE2:Actor events (UT2004)#Tick|Actor.Tick]]



===Other instance functions===
====bDrawRadar====
{{code|simulated function [[bool]] '''bDrawRadar''' ()}}



====DrawRadar====
{{code|simulated function '''DrawRadar''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''', [[float]] '''CenterRadarPosX''', [[float]] '''CenterRadarPosY''', [[float]] '''RadarWidth''', [[UE2:Object structs (UT2004)#Vector|Object.Vector]] '''MapCenter''')}}



====Render====
{{code|simulated function '''Render''' ([[UE2:Canvas (UT2004)|Canvas]] '''C''')}}

'''Overrides:''' [[UE2:HudOverlay (UT2004)#Render|HudOverlay.Render]]



====ToggleRadarMap====
{{code|function '''ToggleRadarMap''' ()}}



{{infobox class
| class = UltimateRadarMapInteraction
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Interaction
| parent2 = Interactions
| parent3 = Object
| custom = yes
}}
{{autogenerated}}

Used by the UltimateRadarMapHUDOverlay to toggle the RadarMap on or off
with F12.

==Properties==
====ParentRadarMapHUDOverlay====
'''Type:''' {{cl|UltimateRadarMapHUDOverlay}}

Set by the HUDOverlay that created us.

==Functions==
===Exec functions===
====ToggleRadarMap====
{{code|exec function '''ToggleRadarMap''' ()}}

User:Crusha/UltimateMappingTools/UltimateRadarMap

2011-10-12T20:56:33Z

Crusha: First revision of page, checked for correctness.

Structs

2011-08-17T12:02:00Z

Crusha: Beware of the fact that iterators will make a copy of the struct instead of a reference.

A '''struct''' (or '''structure''') is a composite data type in [[UnrealScript]], that can contain multiple member variables of (almost) any type, including another struct type. Structs are ''not'' reference types, that means a variable of a struct type actually contains the struct data itself, not a reference to the struct data. This imposes an important restriction on struct types: a struct may not directly or indirectly contain a variable of that same struct type.

'''Note:''' The compiler will probably not complain about a struct violating this restriction. However, if the struct type is used to declare any class or local variables or function parameters or return types, the compiler will likely crash as it attempts to allocate an infinite amount of memory!

==Declaration syntax==
The general syntax of a struct declaration is:
'''struct''' [[#Modifiers|''[modifiers]'']] ''structname'' ['''[[extends]]''' ''parentstruct''] '''{'''
...
'''};'''
Like [[enums]], struct declarations may appear either as standalone declaration, in which case they must be followed by a semicolon, or as inline declaration instead of the type specification in variable declarations. Struct declarations may be contained in other struct declarations, both standalone or in variable declarations. There is no difference between declaring a struct at the class level and within another struct or between a standalone and inline declaration, in all cases the struct is a direct member of the class.

Remember that all members of an UnrealScript class share the same namespace. A struct declaration may hide any member of a parent class if it has the same name.

==Modifiers==
Struct modifiers are not available in [[Unreal Engine 1]]. Most struct modifiers are related to native code.
* 2 – The modifier is available in [[Unreal Engine 2]].
* 3 – The modifier is available in [[Unreal Engine 3]].
* 3+ – The modifier is available in later [[Unreal Engine 3]] versions, such as the [[UDK]].

===Modifiers affecting UnrealEd===
; Long2{{confirm}}: Specifies that the struct contains many members and should not be examined when generating a value string for struct variables in [[UnrealEd]]'s [[Actor properties window]]. Usually structs like [[Vector]] are displayed as "(X=1.2,Y=3.4,Z=5.6)", but with the ''long'' modifier only "(...)" is displayed.

===Modifiers affecting values===
; Immutable3, ImmutableWhenCooked3 : The struct uses [[wp:Serialization|binary serialization]](in previous engine versions some structs used hardcoded binary serialization in c++ e.g. [[Vector]], [[Rotator]] and [[Color]] etc). Without this flag, each struct member will be saved with a ''nameindex'' followed by a ''packedbyte'', ''size'' and ''arrayindex'', then the value of the specific member, thus increases file size and slows down the serialization process.
; Atomic3, AtomicWhenCooked3 : Indicates that this struct should always be serialized as a single unit; if any property in the struct differs from its defaults, then all elements of the struct will be serialized.
; StrictConfig3 : When the struct variable is flagged with ''[[config]]/[[GlobalConfig|globalconfig]]'' then only members with the flag ''config/globalconfig'' will be readable from the .ini, instead of all members.
; Transient2,3 : See [[Variables#Modifiers_affecting_values|Transient]] but instead it applies to all the members of the struct.

===Other modifiers===
; Export2,3 : The struct is supposed to be exported to native headers.
; Init2,3 : '''???'''
; Native2,3 : The struct includes native logic.
; {''native type name''}3 : The type to use in [[native]] code instead of this struct type. This is mainly a hack in Unreal Engine 3 to declare variables in UnrealScript with types the UnrealScript language does not provide. There are only three instances of this syntax in [[UT3]]. The structs [[UE3:Object (UT3)#qword|Object.qword]] and [[UE3:Object (UT3)#double|Object.double]] represent the native types [[wp:Qword#Dword_and_Qword|QWORD]] and [[wp:Double_precision_floating-point_format|DOUBLE]] respectively, and the struct [[UE3:UIEditorOptions (UT3)#ViewportDimension|UIEditorOptions.ViewportDimension]] represents the native type [http://docs.wxwidgets.org/trunk/classwx_rect.html WxRect].

==Member declarations==
Struct members are declared like class [[variables]]. A variable group name or certain [[Variables#Modifiers|variable modifiers]] don't make sense for struct members, though.

Note that in order to refer to structs declared in other classes, you may need to use
[[DependsOn|<code>dependson</code> modifier]].

===Default member values===
By default all struct member variables are initialized with the [[null value]] of the corresponding type.

Starting with [[Unreal Engine 3]], struct members can also have a default value other than the corresponding null value. This can be defined in a [[structdefaultproperties]] block inside the struct declaration. See [[Defaultproperties#Default_struct_properties|structdefaultproperties]] for more details.

==Native struct code==
Like native [[class#Native class code|class]]es, some structs in [[Unreal Engine 2]] and 3 games may contain native code snippets([[cpptext]]) in UnrealScript. These declarations do not affect UnrealScript directly, but they are exported when auto-generating native headers while compiling UnrealScript classes. In [[Unreal Tournament 2004|UT2004]] there are only two struct like this, [[UE2:GUI (UT2004)#GUITreeNode|GUI.GUITreeNode]] and [[UE2:GUIMultiColumnList (UT2004)#MultiColumnSortData|GUIMultiColumnList.MultiColumnSortData]]. In Unreal Engine 3 games this is a much more common sight, especially in UI-related classes.

In Unreal Engine 2 native struct code is enclosed in a '''cppstruct''' block. Unreal Engine 3 uses a '''structcpptext''' block instead.

==Accessing structs==
Accessing a struct is as easily as accessing a [[class]], here's an example.
<uscript>
class A extends Actor;

var() LinearColor RedColor;

// Modify RedColor at Runtime rather than on defaultproperties.
event PreBeginPlay()
{
super.PreBeginPlay(); // Call the parent(i.e. Actor) PreBeginPlay() event
RedColor.R = 1.0; // Make RedColor really red, assuming A is 1.0 and G and B are 0.0.
}
</uscript>

===Accessing structs in arrays===
When working with structs in arrays you need to be aware of the difference between an [[ForEach loop|iterator]] and a regular [[For loop|loop]].

An iterator will create a copy of the actual struct while a loop will use references to the existing structs. That means that you can not change values of the original struct when using iterators.
<uscript>
class A extends Actor;

var() array<LinearColor> Colors;

// Modify Colors at Runtime rather than on defaultproperties.
event PreBeginPlay()
{
local int i;
local LinearColor Iterator;

super.PreBeginPlay(); // Call the parent(i.e. Actor) PreBeginPlay() event

foreach Colors(Iterator)
{
if (Iterator.G == 0.0 && Iterator.B == 0.0)
Iterator.R = 1.0; // This won't have any effect on the struct values in the array.
}

for (i = 0; i < Colors.Length; i++)
{
if (Iterator.G == 0.0 && Iterator.B == 0.0)
Iterator.R = 1.0; // This effects the real struct values in the array.
}
}
</uscript>

{{navbox unrealscript}}

User:Crusha

2011-06-15T07:13:52Z

Crusha:

=About Me=

The full nickname would be Crusha K. Rool, derived from that crocodile-villain from "Donkey Kong", but I prefer Crusha after all.

Since I am dedicated and addicted to UT2004's Onslaught gametype, I once started to get myself familiar with the Unreal Editor 3 and stuck with it down to the present day.

Currently I work with a small team on several projects. One is a yet unannounced medieval multiplayer game, another is the official sequel to a not quite unsuccessful arena-FPS from the year 2002 and the last is a small hobby project that I am doing on my own.

Whenever I have some time between that, I try to finish my UltimateMappingTools (see below) to help the UT2004 community to keep this marvelous game alive for more years to come.

=Projects=

==UE2==
===UltimateMappingTools===

UltimateMappingTools is a toolset started by me with the goal to gather all useful UT2k4-actors out there in one package to give level designers everything they could ever wish to do right at their hand. Several coders have contributed their work to it. I say "thank you" to all of them.

See this page for a full reference: [[User:Crusha/UltimateMappingTools|UltimateMappingTools]]

===DynamicWeather===

DynamicWeather is a toolset by MarZer that contains a whole bunch of actors to put more atmosphere into maps by controlling the natural forces. It is also included in my UltimateMappingTools.

I am '''NOT''' the creator of this actors, they are all done by '''Mark 'MarZer' Gillard'''. I just put the descriptions on my User page because User pages have some functionality for sub-pages that doesn't exist in other namespaces.

See this page for a full reference: [[User:Crusha/DynamicWeather|DynamicWeather]]

==UE3==
===UltimateSaveSystem===

UltimateSaveSystem is a ready-to-use solution for writing and reading variables from UnrealScript or Kismet into and from binary files, using unique names to find the value in the file. It is capable of saving Integer, Float, Boolean, Vector and String variables (with unlimited length).

See this page for a full reference: [[User:Crusha/UltimateSaveSystem|UltimateSaveSystem]]

=Maps=
I early specialized in technically and gameplay-related fine-tuning existing maps (with the author's permission) rather than creating much own stuff, so most of the maps in my "portfolio" owe their being to other guys.

==UT2004==
===ONS-Rail===
[http://forums.epicgames.com/showthread.php?t=724229 Original Thread]

This is a conversion of CTF-Rail to ONS, featuring a lot of NV-mayhem in a narrow corridor-like map with three different levels for Z-axis gameplay and toggleable doors at the Prime Nodes.

===ONS-{DX}Ameliorate===
[http://forums.epicgames.com/showthread.php?t=727952 Original Thread]

This is a conversion of CTF-Ameliorate to ONS, featuring two opposed residences in a sunset scene with a central island surrounded by a canalisation and 4 storage halls. The map is mainly NV, except four Mantas.

===ONS-SavoIsland-K===
[http://forums.epicgames.com/showthread.php?t=728055 Original Thread]

This is a conversion of JB-SavoIsland to ONS and a co-production with Kentaro. The NV-match takes place on a beautiful South Sea island that allows to choose between a fight along the flat beaches or through the hilly inland.

===ONS-Sektor9-Veni-Vidi-Vici===
[http://www.gametracker.com/clan/freelancer/forum.php?thread=29819 Original Thread]

This map was mainly created by VK especially for our ONS-server, but I put a lot of technical and visual fine-tuning into it, so I think it's worth being mentioned here.
Gameplay is crazy, many )o(-vehicles and superweapons and narrow space.

===ONS-Sektor8-The-Battle-Continues===
[http://www.gametracker.com/clan/freelancer/forum.php?thread=32536 Original Thread]

Again another map from VK for our server to which I contributed much fine-tuning. This one is not as narrow as the other one (actually it allows a lot of distance fights in vehicles and Z-axis gameplay), but is not less chaotic. ;)

===ONS-Downtown===
[http://forums.epicgames.com/showthread.php?t=737300 Original Thread]

A rebuild of the UT3-map WAR-TankCrossing for ONS from scratch. The BSP was done by Sanch3z, following the original as accurately as possible, I was responsible for everything else (StaticMeshes, lighting, bot paths, pickups, etc.).

The map uses UltimateDestructibleEnvironment from my MappingTools for destroyable barricades to achieve the same effect as in the original.

===ONS-TankCrossing===
[http://forums.epicgames.com/showthread.php?t=743195 Original Thread]

A rebuild of the UT3-map WAR-TankCrossing for ONS from scratch. The map is still in alpha phase but will feature some intense fights about the control of the single Center Node and the escorting of a team's tank to the enemy PowerCore.

===ONS-GlobeTrotter===
An NV-map that currently only exists as concept. It will be one of the very few maps that makes excessive use of the Escher Physics Mutator (and thus won't work with any bots).

This was only a small selection from the map's I've been working on, but the other's don't have that many noticeable changes or are not supposed

=Contact=
You can contact me in these forums:

[http://www.gametracker.com/crusha_k_rool/ Gametracker]

[http://www.unrealed.info/forum/member.php?u=2140 UnrealEd.info (German site)]

[http://ut2004.titaninternet.co.uk/forums/member.php?u=1873 Titan Onslaught]

[http://forum.omnipotents.com/member.php?u=1703 Omnip)o(tents]

[http://www.vehiclemasters.co.uk/member.php?u=501 Vehicle Masters]

[http://forums.epicgames.com/member.php?u=1387267 Epic Games Forums]

Legacy talk:INT File

2011-06-12T13:42:45Z

Crusha: Here you go, but Czech is not correct.

Retrieved the russian and czech working extensions. Does anybody know the extensions for : dutch, portuguese, finnish, hungarian, greek ?
: I doubt that the Czech variant is correct. The Unreal Engine localization uses the two letters of the [http://www.loc.gov/standards/iso639-2/php/English_list.php ISO 639-1] and adds a 't' after that. So the Czech would be CST, Dutch would be NLT, Portuguese would be PTT, Finnish would be FIT, Hungarian would be HUT and Greek would be ELT. --[[User:Crusha|Crusha]] 13:42, 12 June 2011 (UTC)

Structs

2011-05-20T21:04:37Z

Crusha: Added description for modifiers "Atomic" and "AtomicWhenCooked".

Delegates

2011-05-19T21:43:42Z

Crusha: Added a solution to a problem that made me angry for a few days. :(

A '''delegate''' is a special kind of variable/function combination. Delegates were introduced in [[Unreal Engine 2]] and are declared similar to regular [[functions]]. The difference is, that instead of the keyword ''function'' or ''event'', delegate functions are declared with the keyword ''delegate''. In [[Unreal Engine 3]], delegate functions were accompanied by a delegate variable type, so delegates can now also be stored in structs or arrays and can be passed into or returned by a function.

==Delegate functions==
A delegate function declaration consists of the following parts:
''[[Function#Modifiers|[modifiers]]]'' '''delegate''' ''[[types|[returntype]]]'' ''delegatename'' '''(''' ''[[Function#Parameters|[parameter declarations]]]'' ''')''' ''body_or_semicolon''
Like regular functions, delegates can have a function body, which will be the default function associated with the delegate. If no body is defined, the delegate declaration must be terminated with a semicolon.

Like for regular function declarations, the return type is optional. Similarly, parameter declarations are the same as for regular functions. When assigning a function to the delegate, the function's parameter and return types must match the delegate's. The compiler will make sure this is the case and otherwise throw an error. Parameter names must always be specified, even if the delegate does not have a body definition.

Most function modifiers can be used for delegate functions, but some of them don't make much sense. For example, delegates can't be '''static''' and do not support the Unreal Engine 3 replication modifiers '''client''', '''server''' and '''reliable'''. Note that most modifiers, like '''simulated''', only apply to the delegate body and will not have any effect while other functions are assigned to the delegate.

==Delegate variable type==
The delegate type for variables, parameters and function return types in Unreal Engine 3 looks very similar to a class limiter:
'''delegate <''' ''delegatename'' '''>'''
Here, ''delegatename'' is the name of a delegate function, whose prototype (i.e. parameters and return type) will be used for the delegate variable. Only functions with the same parameter and return types as the referenced delegate function may be assigned to the variable.

While it is possible to declare arrays of delegates, the compiler only allows calling referenced functions through non-array variables. The element of a delegate array first needs to be assigned to a non-array variable of the same delegate type, but can then be called like a normal function.
<uscript>
function callRandomDelegate(array<delegate<X> > delegateList)
{
local delegate<X> selectedDelegate;

// select a random delegate from the list
selectedDelegate = delegateList[Rand(delegateList.Length)];
// call that delegate
selectedDelegate();
}

delegate X();
</uscript>
This example also demonstrates, that the closing angle brackets in arrays of delegates need to be separated by whitespace, just like with class limiters.

==Delegates in Default Properties==
While the compiler won't complain about any assignment of functions to delegates in the default properties and this is also done in some of Epic's own code, it doesn't seem to work well for normal users. Calling a delegate that got assigned per default properties may lead to a crash of the whole engine with an access violation error.

In such a case is it enough to perform the delegate assignment at runtime, for instance in PostBeginPlay().

{{navbox unrealscript}}

User talk:Crusha/UltimateMappingTools

2011-05-11T14:19:45Z

Crusha: Arf, damn you!

Hey, you might want to check the last example on [[Template:Infobox class]] for proper usage of the info box for custom classes. Also it might be a good idea to split up the page now. —[[User:Wormbo|Wormbo]] 09:21, 18 May 2010 (UTC)

Will do that when I find some time, thanks. :)
—[[User:Crusha|Crusha]] 02:04, 22 May 2010 (UTC)

== Clones ==

Just saying, LevelLoadedTrigger already exists in my mapping tool [[LevelConfigManager]] :), I'd say check out my tool before you end up cloning some more without knowing :P, though excuse me for not having a download link yet to the latest version! ----[[User:Eliot|Eliot]] 11:42, 8 May 2011 (UTC)

Arf, damn you! It's a red link, though. But it's not like such a LevelLoaded thing would be that hard to code. ;)
If yours is named exactly the same way, I will rename mine slightly to avoid confusion when using both packs at the same time. I kinda rely on it's reset functionality because I didn't implement it in some of the other Actors. --[[User:Crusha|Crusha]] 14:19, 11 May 2011 (UTC)

User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart

2011-05-08T21:27:58Z

Crusha: Corrected Wikifier links

=LockerWeaponsPlayerStart=
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest
WeaponLocker in the specified range.
The Event is triggered when the player spawns.

==Properties==
===Property group 'LockerWeaponsPlayerStart'===
====AssignLocker====
'''Type:''' [[UE2:WeaponLocker_(UT2004)|WeaponLocker]]

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

Always use the locker that is specified here. Search for a locker in radius at runtime if none is specified. Overrides bAlwaysRefreshClosestLocker.

====bAlwaysRefreshClosestLocker====
'''Type:''' [[bool]]

Enabling this will perform a check to find the closest Locker every time a player respawns.

This allows to always use the closest Locker in case that this PlayerStart is attached to a Mover and moves away from it's initial location.
However, performing the check is processing intense, so you should disable this if the PlayerStart is not attached to a Mover.

====MaxWeaponLockerDistance====
'''Type:''' [[float]]

The player will spawn with the weapons from the closest WeaponLocker within this distance.

'''Default value:''' 1000.0

===Internal variables===
====BestLocker====
'''Type:''' [[UE2:WeaponLocker_(UT2004)|WeaponLocker]]

The closest WeaponLocker found in proximity.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| Event
| 'LWPSSN'
|}

==Instance functions==
====BeginPlay====
{{code|function '''BeginPlay''' ()}}

Set up the SpawnNotifier.

====EquipSpawnedPlayer====
{{code|function '''EquipSpawnedPlayer''' ([[UE2:Pawn (UT2004)|Pawn]] '''P''')}}

Called by the SpawnNotifier.

====FindClosestLocker====
{{code|function [[UE2:WeaponLocker_(UT2004)|WeaponLocker]] '''FindClosestLocker''' ([[Vector]] '''StartLocation''', [[float]] '''SearchRadius''')}}

Finds the closest locker. Obvious.

====PostBeginPlay====
{{code|function '''PostBeginPlay''' ()}}

Find a WeaponLocker in range.

=LockerWeaponsPlayerStartSpawnNotifier=
{{infobox class
| class = LockerWeaponsPlayerStartSpawnNotifier
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Info
| custom = yes
}}

This is a hack to get the LockerWeaponsPlayerStart to work.
The PlayerStart itself doesn't get any notification when a player spawns there
but the GameInfo triggers the Event of the PlayerStart where the player was
spawned.

So we simply let every LockerWeaponsPlayerStart trigger us and then re-route
the necessary information to him, because that is given with the TriggerEvent.

==Events==
====Trigger====
{{code|event '''Trigger''' ([[UE2:Actor (UT2004)|Actor]] '''Other''', [[UE2:Pawn (UT2004)|Pawn]] '''EventInstigator''')}}

Call EquipSpawnPlayer() in the PlayerStart that triggered the Event and pass the Instigator as the spawned player.

User:Crusha/UltimateMappingTools

2011-05-08T11:17:10Z

Crusha: Fixed class parents.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more informations about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more informations about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more informations about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more informations about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more informations about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more informations about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more informations about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more informations about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more informations about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| parent2 = PhysicsVolume
| parent3 = Volume
| parent4 = Brush
| parent5 = Actor
| parent6 = Object
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more informations about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| parent2 = Volume
| parent3 = Brush
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more informations about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more informations about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more informations about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more informations about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more informations about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more informations about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more informations about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more informations about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more informations about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more informations about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more informations about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from these informations. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more informations about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more informations about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more informations about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more informations about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more informations about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more informations about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| parent2 = ScriptedAction
| parent3 = Object
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| parent2 = LatentScriptedAction
| parent3 = ScriptedAction
| parent4 = Object
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more informations about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more informations about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| parent2 = Projector
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more informations about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more informations about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more informations about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more informations about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/VehicleTeleporter

2011-05-08T11:09:12Z

Crusha: Removed links

{{infobox class
| class = VehicleTeleporter
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}
VehicleTeleporter v1.0 by KillBait!

A Teleporter that can be used by players AND vehicles. Works with bots too.
Tested on a dedicated (v3339) server and it runs O.K.

''Goals''

The aim was to have a teleport that was usable by both vehicles and players,
and still used the normal teleporter functions, to make it as easy as possible
for LD's to use, and required no extra work on server admins for them to
support these new features.

''Usage Restrictions''

You are Free to use this actor in whatever type of Map/Mod/TC you want,
BUT, please do not rip out/remove the notes and comments. I have learned
a lot from looking at other peoples code, and i want to keep it here for
others to look at. Maybe, even with my newbie coding skills, it will be
of help to somebody.

''Credits''

- ROBO (UT2004ModList) Came up with the original SetPhysics workaround

- Derek "HoMeRS}i{MpSoN" Altamirano for the hint on the velocity multipler code.

- Steve Polge for the suggestion to widen the reachspec collision, stops bots bailing out just before teleporting, because they could not find a wide enough path.

- UnrealWiki for it's invaluable documentation of some fuctions i've never used before this.

- All other Code/bugs by Me (KillBait!)

==Properties==
===Property group 'VehicleTeleporter'===
====bGroundVehiclesOnly====
'''Type:''' [[bool]]

The teleporter won't work on flying vehicles.

====bTeleportVehiclesOnly====
'''Type:''' [[bool]]

No players are teleported.

===Internal variables===
====bKeepFlyingUpright====
'''Type:''' [[bool]]

For some reason is bKStayUpright set to False for vehicles that are teleported, but that would render any flying vehicle really unstable, so we remember the value and set it back afterwards.

====ReachSpecCollHeight====
'''Type:''' [[int]]

Changes the collision height of the destination path to this. So bots don't bail.

====ReachSpecCollRadius====
'''Type:''' [[int]]

Changes the collision radius of the destination path to this. So bots don't bail.

==Functions==
===Events===
====Accept====
{{code|simulated event [[bool]] '''Accept''' ({{cl|Actor}} '''Incoming''', {{cl|Actor}} '''Source''')}}

'''Overrides:''' {{tl|Accept|Teleporter}}



====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' {{tl|PostBeginPlay|Teleporter}}



====PostTouch====
{{code|simulated event '''PostTouch''' ({{cl|Actor}} '''Other''')}}

'''Overrides:''' {{tl|PostTouch|Teleporter}}



====SpecialCost====
{{code|event [[int]] '''SpecialCost''' ({{cl|Pawn}} '''Other''', {{cl|ReachSpec}} '''Path''')}}

'''Overrides:''' {{tl|SpecialCost|Teleporter}}



====SpecialHandling====
{{code|event {{cl|Actor}} '''SpecialHandling''' ({{cl|Pawn}} '''Other''')}}

'''Overrides:''' {{tl|SpecialHandling|Teleporter}}



====Touch====
{{code|event '''Touch''' ({{cl|Actor}} '''Other''')}}

'''Overrides:''' {{tl|Touch|Teleporter}}



===Other instance functions===
====ClearDest====
{{code|function '''ClearDest''' ({{cl|Actor}} '''Incoming''', {{cl|Actor}} '''Source''')}}

User:Crusha/UltimateMappingTools/VehicleTeleporter

2011-05-08T11:07:53Z

Crusha: First revision of the page. Autogenerated but checked for correctness.

{{infobox class
| class = VehicleTeleporter
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| custom = yes
}}
VehicleTeleporter v1.0 by KillBait!

A Teleporter that can be used by players AND vehicles. Works with bots too.
Tested on a dedicated (v3339) server and it runs O.K.

''Goals''

The aim was to have a teleport that was usable by both vehicles and players,
and still used the normal teleporter functions, to make it as easy as possible
for LD's to use, and required no extra work on server admins for them to
support these new features.

''Usage Restrictions''

You are Free to use this actor in whatever type of Map/Mod/TC you want,
BUT, please do not rip out/remove the notes and comments. I have learned
a lot from looking at other peoples code, and i want to keep it here for
others to look at. Maybe, even with my newbie coding skills, it will be
of help to somebody.

''Credits''

- ROBO (UT2004ModList) Came up with the original SetPhysics workaround

- Derek "HoMeRS}i{MpSoN" Altamirano (http://www.cyberrock.net) for the
hint on the velocity multipler code.

- Steve Polge for the suggestion to widen the reachspec collision, stops
bots bailing out just before teleporting, because they could not find
a wide enough path.

- UnrealWiki (http://www.UnrealWiki.com) for it's invaluable documentation
of some fuctions i've never used before this.

- All other Code/bugs by Me (KillBait!)

==Properties==
===Property group 'VehicleTeleporter'===
====bGroundVehiclesOnly====
'''Type:''' [[bool]]

The teleporter won't work on flying vehicles.

====bTeleportVehiclesOnly====
'''Type:''' [[bool]]

No players are teleported.

===Internal variables===
====bKeepFlyingUpright====
'''Type:''' [[bool]]

For some reason is bKStayUpright set to False for vehicles that are teleported, but that would render any flying vehicle really unstable, so we remember the value and set it back afterwards.

====ReachSpecCollHeight====
'''Type:''' [[int]]

Changes the collision height of the destination path to this. So bots don't bail.

====ReachSpecCollRadius====
'''Type:''' [[int]]

Changes the collision radius of the destination path to this. So bots don't bail.

==Functions==
===Events===
====Accept====
{{code|simulated event [[bool]] '''Accept''' ({{cl|Actor}} '''Incoming''', {{cl|Actor}} '''Source''')}}

'''Overrides:''' {{tl|Accept|Teleporter}}



====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' {{tl|PostBeginPlay|Teleporter}}



====PostTouch====
{{code|simulated event '''PostTouch''' ({{cl|Actor}} '''Other''')}}

'''Overrides:''' {{tl|PostTouch|Teleporter}}



====SpecialCost====
{{code|event [[int]] '''SpecialCost''' ({{cl|Pawn}} '''Other''', {{cl|ReachSpec}} '''Path''')}}

'''Overrides:''' {{tl|SpecialCost|Teleporter}}



====SpecialHandling====
{{code|event {{cl|Actor}} '''SpecialHandling''' ({{cl|Pawn}} '''Other''')}}

'''Overrides:''' {{tl|SpecialHandling|Teleporter}}



====Touch====
{{code|event '''Touch''' ({{cl|Actor}} '''Other''')}}

'''Overrides:''' {{tl|Touch|Teleporter}}



===Other instance functions===
====ClearDest====
{{code|function '''ClearDest''' ({{cl|Actor}} '''Incoming''', {{cl|Actor}} '''Source''')}}

User:Crusha/UltimateMappingTools

2011-05-07T19:58:53Z

Crusha: /* UTAction_WaitOnlyForTimer */ The case of the superclass again... Wikifier is broken in that relation.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more informations about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more informations about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more informations about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more informations about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more informations about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more informations about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more informations about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more informations about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more informations about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more informations about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more informations about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more informations about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more informations about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more informations about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more informations about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more informations about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more informations about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more informations about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more informations about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more informations about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more informations about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from these informations. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more informations about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more informations about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more informations about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more informations about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more informations about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more informations about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForTimer
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more informations about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more informations about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more informations about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more informations about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more informations about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more informations about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools

2011-05-07T19:57:52Z

Crusha: Some stuff was not matching.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more informations about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more informations about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more informations about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more informations about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more informations about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more informations about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more informations about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more informations about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more informations about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more informations about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more informations about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more informations about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more informations about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more informations about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more informations about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more informations about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more informations about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more informations about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more informations about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more informations about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more informations about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from these informations. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more informations about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more informations about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more informations about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the instigator of the Event belongs to the specified team.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more informations about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more informations about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more informations about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForEvent==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitOnlyForTimer==
by Wormbo
{{infobox class
| class = UTAction_WaitOnlyForTimer
| game = UT2004
| engine = UE2
| parent1 = Action_WaitForTimer
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more informations about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more informations about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more informations about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more informations about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more informations about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more informations about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart

2011-05-07T19:49:17Z

Crusha: First revision of the page. Autogenerated but checked for correctness.

=LockerWeaponsPlayerStart=
{{infobox class
| class = LockerWeaponsPlayerStart
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = TriggeredPlayerStart
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest
WeaponLocker in the specified range.
The Event is triggered when the player spawns.

==Properties==
===Property group 'LockerWeaponsPlayerStart'===
====AssignLocker====
'''Type:''' {{cl|WeaponLocker}}

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

Always use the locker that is specified here. Search for a locker in radius at runtime if none is specified. Overrides bAlwaysRefreshClosestLocker.

====bAlwaysRefreshClosestLocker====
'''Type:''' [[bool]]

Enabling this will perform a check to find the closest Locker every time a player respawns.

This allows to always use the closest Locker in case that this PlayerStart is attached to a Mover and moves away from it's initial location.
However, performing the check is processing intense, so you should disable this if the PlayerStart is not attached to a Mover.

====MaxWeaponLockerDistance====
'''Type:''' [[float]]

The player will spawn with the weapons from the closest WeaponLocker within this distance.

'''Default value:''' 1000.0

===Internal variables===
====BestLocker====
'''Type:''' {{cl|WeaponLocker}}

The closest WeaponLocker found in proximity.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| Event
| 'LWPSSN'
|}

==Instance functions==
====BeginPlay====
{{code|function '''BeginPlay''' ()}}

Set up the SpawnNotifier.

====EquipSpawnedPlayer====
{{code|function '''EquipSpawnedPlayer''' ({{cl|Pawn}} '''P''')}}

Called by the SpawnNotifier.

====FindClosestLocker====
{{code|function {{cl|WeaponLocker}} '''FindClosestLocker''' ({{cl|vector}} '''StartLocation''', [[float]] '''SearchRadius''')}}

Finds the closest locker. Obvious.

====PostBeginPlay====
{{code|function '''PostBeginPlay''' ()}}

Find a WeaponLocker in range.

=LockerWeaponsPlayerStartSpawnNotifier=
{{infobox class
| class = LockerWeaponsPlayerStartSpawnNotifier
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Info
| custom = yes
}}

This is a hack to get the LockerWeaponsPlayerStart to work.
The PlayerStart itself doesn't get any notification when a player spawns there
but the GameInfo triggers the Event of the PlayerStart where the player was
spawned.

So we simply let every LockerWeaponsPlayerStart trigger us and then re-route
the necessary information to him, because that is given with the TriggerEvent.

==Events==
====Trigger====
{{code|event '''Trigger''' ({{cl|Actor}} '''Other''', {{cl|Pawn}} '''EventInstigator''')}}

Call EquipSpawnPlayer() in the PlayerStart that triggered the Event and pass the Instigator as the spawned player.

User:Crusha/UltimateMappingTools/BlockingVolumeToggleable

2011-05-07T12:56:41Z

Crusha: First revision of the page. Autogenerated but checked for correctness.

{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

==Properties==
===Property group 'BlockingVolumeToggleable'===
====bChangeBlockActors====
'''Type:''' [[bool]]

This collision type is changed on triggering.

'''Default value:''' True

====bChangeBlockPlayers====
'''Type:''' [[bool]]

This collision type is changed on triggering.

====bChangeCollideActors====
'''Type:''' [[bool]]

This collision type is changed on triggering.

'''Default value:''' True

====bTriggerControlled====
'''Type:''' [[bool]]

If True, untriggering will disable all collision and triggering will enable all.
If False, triggering will toggle.

'''Default value:''' True

===Internal variables===
====bBlockActorsCopy====
'''Type:''' [[bool]]

For replication.

====bBlockPlayersCopy====
'''Type:''' [[bool]]

For replication.

====bCollideActorsCopy====
'''Type:''' [[bool]]

For replication.

===Default values===
{| class="list defaults"
! Property
! Value
|-
| bNetNotify
|
|-
| bNoDelete
|
|-
| bStatic
|
|-
| NetPriority
|
|-
| NetUpdateFrequency
|
|-
| RemoteRole
|
|}

==Functions==
===Events===
====PostNetRecieve====
{{code|simulated event '''PostNetRecieve''' ()}}

Change client collision if the replicated values don't match the active ones.

===Other instance functions===
====Trigger====
{{code|function '''Trigger''' ({{cl|Actor}} '''Other''', {{cl|Pawn}} '''EventInstigator''')}}

Toggle the values or enable all, depending on mode.

====UnTrigger====
{{code|function '''UnTrigger''' ({{cl|Actor}} '''Other''', {{cl|Pawn}} '''EventInstigator''')}}

Disable all values, if that mode is used.

User:Crusha/UltimateMappingTools

2011-05-07T12:50:51Z

Crusha: /* BlockingVolumeToggleable */ Wrong infobox.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more informations about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more informations about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more informations about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more informations about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more informations about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more informations about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more informations about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more informations about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more informations about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more informations about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = BlockingVolumeToggleable
| game = UT2004
| engine = UE2
| parent1 = BlockingVolume
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more informations about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more informations about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more informations about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more informations about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more informations about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more informations about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more informations about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more informations about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more informations about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more informations about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more informations about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from these informations. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more informations about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more informations about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more informations about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more informations about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more informations about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more informations about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more informations about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more informations about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more informations about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more informations about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more informations about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more informations about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools/HealVolume

2011-05-07T12:49:10Z

Crusha: First revision of the page. Autogenerated but checked for correctness.

{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| package = UltimateMappingTools
| parent1 = Volume
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

==Properties==
===Property group 'HealVolume'===
====bActive====
'''Type:''' [[bool]]

If True, the Volume will heal from the beginning.

====bSuperHeal====
'''Type:''' [[bool]]
Heals up to SuperHealth like Keg and Vials do.

====bTriggerHeal====
'''Type:''' [[bool]]

If True, the health will only be added to pawns that are inside at the moment the Volume is triggered.
If False, it will heal over time.

====HealAmount====
'''Type:''' [[int]]

How much to heal per second or per triggering.

====HealClass====
'''Type:''' [[class]]<{{cl|Pawn}}>

Heal actors of the following class, including subclasses. For example choose "Vehicle" for vehicles, "xPawn" for players or "Pawn" for both.

===Internal variables===
====bOldActive====
'''Type:''' [[bool]]

For resetting.

==Instance functions==
====PostBeginPlay====
{{code|function '''PostBeginPlay''' ()}}

See if we use TriggerHeal or HealOverTime and put us in the right state.

====Reset====
{{code|function '''Reset''' ()}}

Set bActive to what it was when the match was started.

==States==
===HealOverTime===


'''[[States#Modifiers|Modifiers]]:''' auto

====HealOverTime.Timer====
{{code|function '''Timer''' ()}}

Heal every second.

====HealOverTime.Trigger====
{{code|function '''Trigger''' ({{cl|Actor}} '''Other''', {{cl|Pawn}} '''EventInstigator''')}}

Start healing every second.

====HealOverTime.UnTrigger====
{{code|function '''UnTrigger''' ({{cl|Actor}} '''Other''', {{cl|Pawn}} '''EventInstigator''')}}

Stop healing every second.

===TriggerHeal===


====TriggerHeal.Trigger====
{{code|function '''Trigger''' ({{cl|Actor}} '''Other''', {{cl|Pawn}} '''EventInstigator''')}}

Heal on triggering.

User:Crusha/UltimateMappingTools

2011-05-07T12:31:53Z

Crusha: Added HealVolume, VolumeUnTrigger and LevelLoadedTrigger, BlockingVolumeToggleable, DynamicPhysicVolumes and CountdownEventGate

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more informations about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more informations about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more informations about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more informations about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more informations about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more informations about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more informations about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more informations about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more informations about this Actor.

==DynamicPhysicsVolume==
by Epic Games
{{infobox class
| class = DynamicPhysicsVolume
| game = UT2004
| engine = UE2
| parent1 = PhysicsVolume
| custom = yes
}}

This is a movable PhysicsVolume. It can be attached to dynamic objects.

==DynamicWaterVolume==
by Epic Games
{{infobox class
| class = DynamicWaterVolume
| game = UT2004
| engine = UE2
| parent1 = WaterVolume
| custom = yes
}}

This is a movable WaterVolume. It can be attached to dynamic objects.

==HealVolume==
by Crusha K. Rool
{{infobox class
| class = HealVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

Volume that allows to heal player or vehicles inside it.

See [[User:Crusha/UltimateMappingTools/HealVolume|this page]] for more informations about this Actor.

==BlockingVolumeToggleable==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| custom = yes
}}

The collision of this BlockingVolume can be toggled when it gets triggered.

See [[User:Crusha/UltimateMappingTools/BlockingVolumeToggleable|this page]] for more informations about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more informations about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more informations about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more informations about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more informations about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==LevelLoadedTrigger==
by Crusha K. Rool
{{infobox class
| class = LevelLoadedTrigger
| game = UT2004
| engine = UE2
| parent1 = Triggers
| custom = yes
}}

Triggers the default Event as soon as the level is loaded and triggers the ResetEvent when the round ended and is reset.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more informations about this Actor.

==VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = VolumeTrigger
| custom = yes
}}

Same functionality as VolumeTrigger, but can ADDITIONALLY untrigger
a Volume when this gets untriggered.
Only the BlockingVolumeToggleable and the HealVolume supports untriggering for now!

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more informations about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more informations about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more informations about this Actor.

==CountdownEventGate==
by Crusha K. Rool
{{infobox class
| class = CountdownEventGate
| game = UT2004
| engine = UE2
| customparent1 = EventGate
| parent2 = Triggers
| custom = yes
}}

Waits a certain time before triggering the next Event.
If the Actor gets untriggered in that time, the countdown stops.
There is a ToleranceTime in which the event can be triggered again after being disabled to
continue the current countdown.

The current countdown state can be broadcasted to the HUD.

See [[User:Crusha/UltimateMappingTools/CountdownEventGate|this page]] for more informations about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more informations about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from these informations. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more informations about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more informations about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more informations about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more informations about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more informations about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more informations about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more informations about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more informations about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more informations about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more informations about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more informations about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more informations about this Actor.

[[Category:Mapping tools]]

User:Crusha/UltimateMappingTools

2011-05-06T18:33:08Z

Crusha: Omitted package references and fixed case-problem with autogenerated links to some ScriptedActions.

=Introduction=

==About this site==
This site is dedicated to my upcoming toolset for Unreal Tournament 2004, formerly known as '''UltimateONSTools'''. It serves as a documentation to the tool set and will explain the effects of each variable in each Actors. A separate page gives some examples of how the contents of this set can be put to use.

Please do not apply any changes on this site, I will maintain it on my own. Use the discussion page for feedback.

==Motivation==
First I just wanted to create a VehicleFactory for ONS that allows the mapper to configure more than he can with the default one. It worked fine, but then I wanted to have even more control as a mapper about the game flow by considering which PowerNodes in ONS are captured by a team and which are not.
The idea itself grew when I saw UT3's ''Kismet'' and decided to create something for all UT2004-mappers that gives them somewhat similar influence about what happens during the match.
In the end I came to a point where I wanted to gather everything that a mapper could ever wish to use in map in this set - one single .u-file that every mapper should add to his EditPackages list and be happy. :)

There would be no use in recreating something that has been done by other coders already. And because we are one big community, I asked other coders if I could use some of their work here, especially such things that exist not in their own .u-file.
They were very friendly, especially Wormbo. Half of the things in this pack come from him!
The Actors from other coders have been renamed for this toolset to avoid conflicts with the originals. Most Actors from Jailbreak have been renamed from "JBxyz" to "UTxyz" (because UT stands for UltimateTools :P), only a few remained "Ultimate".

'''Note''': In my Actors can "red" and "blue" be considered static on the map, that means the mapper only has to think in a way like he would map for gametypes where the teams won't switch sides after reset. If the sides are swapped in ONS, then my Actors will handle this automatically and work properly for the other team on that side of the map.

=Enhanced Functionality=
Tools in this section are highly improved versions of existing UT2004 versions and add a lot of new features.

==UltimateONSFactory==
by Crusha K. Rool, thanks to iwanpompier for help at getting the radar to work
{{infobox class
| class = UltimateONSFactory
| parent1 = ONSVehicleFactory
| parent2 = SVehicleFactory
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An ONS-mapper's jack of all trades device. This allows the mapper to tweak the vehicle balance of the match right down to the last detail.
Allows to specify an individual vehicle list for both teams from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to track the vehicle on the RadarMap.

See [[User:Crusha/UltimateMappingTools/UltimateONSFactory|this page]] for more informations about this Actor.

==UltimateVCTFFactory==
by Crusha K. Rool
{{infobox class
| class = UltimateVCTFFactory
| parent1 = SVehicleFactory
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The VCTF equivalent to the UltimateONSFactory. Allows to set up a list of vehicles from which the next vehicle can be chosen randomly or sequentially.
Each individual vehicle entry in a list can be further modified, also with the ability to change if a vehicle can carry the flag or not. This has less options than the UltimateONSFactory but can be used in any gametype, even those where vehicles are disabled by default.

See [[User:Crusha/UltimateMappingTools/UltimateVCTFFactory|this page]] for more informations about this Actor.

==UltimateMover==
by Wormbo, originally named JBMoverDualDestination in the package 'JBToolbox2'
{{infobox class
| class = UltimateMover
| parent1 = Mover
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A mover with a multitude of improvements over standard movers:

* can trigger an event when receiving damage (like Wormbo's custom [[User:Wormbo/DamageTriggerMover|DamageTriggerMover]])
* can trigger/untrigger an event when someone stands in it (not only in StandOpenTimed state)
* mapper can define two different movement paths with individual trigger tags, sounds and events
* mapper can specify separate open and close times (like VitalOverdose's [[Legacy:VitalOverdose/VariableTimedMover|VariableTimedMover]])
* mapper can specify individual move times for every key (like SuperApe's [[UE2:VariableTimedMover|VariableTimedMover]])

See [[JDN:JBMoverDualDestination]] for more informations about this Actor.

==UTNetworkProjectileSpawner==
by Wormbo, originally named NetworkProjectileSpawner in the package 'NetworkProjectileSpawner'
{{infobox class
| class = UTNetworkProjectileSpawner
| parent1 = Actor
| parent2 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

An advanced network-compatible ProjectileSpawner alternative mappers can add to their levels.

This features an incredible amount of options to create your own projectile in any way you like. And I will not list all those 70 properties here. Luckily the Worm itself documented it in all details.

See [[User:Wormbo/NetworkProjectileSpawner|this page]] for more informations about this Actor.

==LockerWeaponsPlayerStart==
by Crusha K. Rool
{{infobox class
| class = LockerWeaponsPlayerStart
| parent1 = TriggeredPlayerStart
| parent2 = PlayerStart
| parent3 = SmallNavigationPoint
| parent4 = NavigationPoint
| parent5 = Actor
| parent6 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This PlayerStart equips the spawning player with the weapons from the closest WeaponLocker in the specified range.

See [[User:Crusha/UltimateMappingTools/LockerWeaponsPlayerStart|this page]] for more informations about this Actor.

==UTKickerTriggerable==
by Wormbo, originally named JBKickerTriggerable in the package 'JBToolbox2'
{{infobox class
| class = UTKickerTriggerable
| parent1 = xKicker
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A triggerable xKicker with several additional features:

* can be trigger-toggled or trigger-controlled on/off
* defines directions "in front" and "behind" by its location and rotation so it can ignore touches if touching Actor is behind and mirror the kick direction if the touching Actor is behind
* can cause damage to kicked Actors
* can play a sound on the kicked Actor

See [[JDN:JBKickerTriggerable]] for more informations about this Actor.

==VehicleTeleporter==
by KillBait
{{infobox class
| class = VehicleTeleporter
| parent1 = Teleporter
| parent2 = SmallNavigationPoint
| parent3 = NavigationPoint
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Teleporter that can also teleport vehicles. Works in online games and with bot support.

See [[User:Crusha/UltimateMappingTools/VehicleTeleporter|this page]] for more informations about this Actor.

==UltimateDestroyableEnvironment==
by Crusha K. Rool
{{infobox class
| class = UltimateDestroyableEnvironment
| parent1 = Decoration
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A StaticMesh that can change it's appearance when taking a certain amount of damage. Additionally it can play sounds, spawn KActors and use Emitter effects when it reaches the next ''Level of Destruction''.

See [[User:Crusha/UltimateMappingTools/UltimateDestructibleEnvironment|this page]] for more informations about this Actor.

==UTTunnelExitVolume==
by Wormbo, originally named JBVolumeTunnelExit in the package 'JBToolbox'
{{infobox class
| class = UTTunnelExitVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Volume that allowes players to walk or crouch off ledges. Useful wherever a player has to get off a human ladder or exit a tunnel while crouching.

See [[JDN:JBVolumeTunnelExit]] for more informations about this Actor.

==UltimateSkyZoneInfo==
by Wormbo and Crusha K. Rool
{{infobox class
| class = UltimateSkyZoneInfo
| parent1 = ZoneInfo
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Don't get confused by the name, this Actor is supposed to be used instead of a ZoneInfo and not instead of a SkyZoneInfo!

This is an enhanced version Wormbo's [[User:Wormbo/SelectableSkyZoneInfo|SelectableSkyZoneInfo]]. It allows to choose which skybox can be seen from the current Zone (including the ability to have different skyboxes with different detail levels to choose from) and additionally to specify completely different skyboxes from which one is chosen randomly at the beginning of the match, resulting in the ability to play the same map in a completely different environment each time you play it.

See [[User:Crusha/UltimateMappingTools/UltimateSkyZoneInfo|this page]] for more informations about this Actor.

==ParallaxSkyZoneInfo==
by Party Boy
{{infobox class
| class = ParallaxSkyZoneInfo
| parent1 = SkyZoneInfo
| parent2 = ZoneInfo
| parent3 = Info
| parent4 = Actor
| parent5 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Moves the skybox around with the players view in order to simulate a distant environment like in UT3 instead of one that is static and infinitely far away. A skybox must be set up to match certain requirements since the actualy SkyZoneInfo is moving around in the skybox and thereby could pass through StaticMeshes (also fog rings) that are placed in traditional skyboxes.

See [[User:Crusha/UltimateMappingTools/ParallaxSkyZoneInfo|this page]] for more informations about this Actor.

==UltimateRadarMap==
by Crusha K. Rool
{{infobox class
| class = UltimateRadarMap
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Place this Actor in the map to be able to display an ONSlaught-like RadarMap in the HUD in any gametype you wish.

Supported are CTF gametypes (CTF, CTF4, VCTF), BR gametypes (BR, BR4, Bombing Spree Mutator), Domination (DOM, Triple Domination) and Assault. Supported means, that those will display the GameObjectives properly for that gametype. Unsupported gametypes can still be set to show all currently active GameObjectives or just simply show the RadarMap to give some feedback about your location.

In order to display a RadarMap you have to set one up in the LevelProperties as you would do in ONS.

See [[User:Crusha/UltimateMappingTools/UltimateRadarMap|this page]] for more informations about this Actor.

==EnhancedLevelGameRules==
created mainly by Wormbo
{{infobox class
| class = EnhancedLevelGameRules
| parent1 = LevelGameRules
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Additionally to the functionality of the normal LevelGameRules, this one can also forbid certain Mutators in the map. That way can a leveldesigner override the Server Mutators completely.

However, in order to prevent major abuse, this Actor will not disable Mutators with the GroupName 'Security', like Anti-TCC, UTSecure, etc.

See [[User:Crusha/UltimateMappingTools/EnhancedLevelGameRules|this page]] for more informations about this Actor.

=Trigger Systems=
Tools in this section are used to add more functionality and control to the Trigger system of the Unreal Engine.

==PlayerCountTrigger==
by Crusha K. Rool
{{infobox class
| class = PlayerCountTrigger
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers an Event when at least so many players are in the game as specified here.
Untriggers it when the PlayerCount shrinks below the specified amount again.

See [[User:Crusha/UltimateMappingTools/PlayerCountTrigger|this page]] for more informations about this Actor.

==EventGate==
by Crusha K. Rool
{{infobox class
| class = EventGate
| parent1 = Triggers
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all custom Actors that handle TriggerEvents and UnTriggerEvents. All subclasses have collision disabled because they only depend on triggering.

==LogicGate==
by Crusha K. Rool
{{infobox class
| class = LogicGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

The abstract base class of all logic gates. The only purpose of this class is to group the subclasses.

The following subclasses exist:

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOT|LogicalNOT]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalOR|LogicalOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalAND|LogicalAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNOR|LogicalNOR]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalNAND|LogicalNAND]]

[[User:Crusha/UltimateMappingTools/LogicGate#LogicalXOR|LogicalXOR]]

==UnTriggerEventGate==
by Crusha K. Rool
{{infobox class
| class = UnTriggerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This actor turns the incoming UnTriggerEvents into TriggerEvents or the other way around.

See [[User:Crusha/UltimateMappingTools/UnTriggerEventGate|this page]] for more informations about this Actor.

==LinksetupEventGate==
by Crusha K. Rool
{{infobox class
| class = LinksetupEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

When being triggered, this will only trigger the next Event, if the current Linksetup matches one of the ones specified in the array.

See [[User:Crusha/UltimateMappingTools/LinksetupEventGate|this page]] for more informations about this Actor.

==RandomEventGate==
by Crusha K. Rool
{{infobox class
| class = RandomEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Triggers the next Event with a probability that can be defined by the mapper.
You can also set an alternative Event that is used instead, if the other one is not chosen.

See [[User:Crusha/UltimateMappingTools/RandomEventGate|this page]] for more informations about this Actor.

==VIPlayerEventGate==
by Crusha K. Rool
{{infobox class
| class = VIPlayerEventGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

See [[User:Crusha/UltimateMappingTools/VIPlayerEventGate|this page]] for more informations about this Actor.

==NodeEventDirector==
by Crusha K. Rool
{{infobox class
| class = NodeEventDirector
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor receives the three Events of an ONSPowerNode and interprets the current state of the node from these informations. The Actor can then fire Trigger- or UnTrigger-Events when the state of the Node changes.

See [[User:Crusha/UltimateMappingTools/NodeEventDirector|this page]] for more informations about this Actor.

==InstigatorModifier==
by Crusha K. Rool
{{infobox class
| class = InstigatorModifier
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Changes the properties of the Pawn that triggered the Event to the specified ones.

See [[User:Crusha/UltimateMappingTools/InstigatorModifier|this page]] for more informations about this Actor.

==ScoreContainer==
by Crusha K. Rool
{{infobox class
| class = ScoreContainer
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This section handles four Actors that are all related to implementing a custom score system in maps, allowing to create an RTS-like resource system or simply doing addition and subtraction based event triggering.

See [[User:Crusha/UltimateMappingTools/ScoreContainer|this page]] for more informations about these Actors.

=ScriptedActions=
This section lists new ScriptedActions that are available in ScriptedTriggers when this toolset is used.

==ACTION_IfInstigatorTeam==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfInstigatorTeam
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfInstigatorTeam|this page]] for more informations about this Actor.

==ACTION_IfLinksetup==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfLinksetup
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if the currently active linksetup is specified in this Action's array
and this is an ONS map.

See [[User:Crusha/UltimateMappingTools/ACTION_IfLinksetup|this page]] for more informations about this Actor.

==ACTION_IfPlayerCount==
by Crusha K. Rool
{{infobox class
| class = ACTION_IfPlayerCount
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Enters the following section only if at least a specific number of players
is in the match.

See [[User:Crusha/UltimateMappingTools/ACTION_IfPlayerCount|this page]] for more informations about this Actor.

==ACTION_UnTriggerEvent==
by Crusha K. Rool
{{infobox class
| class = Action_UNTRIGGEREVENT
| game = UT2004
| engine = UE2
| parent1 = ACTION_TriggerEvent
| custom = yes
}}

Nothing special, really. Basically the same as ACTION_TriggerEvent, just that this untriggers the specified Event instead of triggering it.

==ACTION_VolumeTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Isn't it much better to have this in a ScriptedTrigger instead of having a dedicated Actor just for the purpose of triggering Volumes?

==ACTION_VolumeUnTrigger==
by Crusha K. Rool
{{infobox class
| class = ACTION_VolumeUnTrigger
| game = UT2004
| engine = UE2
| parent1 = ScriptedAction
| custom = yes
}}

Do I have to say anything? Maybe that there is basically no Volume out there that reacts on untriggering, except for my BlockingVolumeToggleable. Maybe I'll add more.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForCondition
| game = UT2004
| engine = UE2
| parent1 = LatentScriptedAction
| custom = yes
}}

Waits until a TriggeredCondition has a certain value. Completes either
instantly when the condition is matched or waits until the condition stays in
that state for a specified duration.

=Fix=
These are community fixes for original stuff from the game that is not properly working in some scenarios.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Works around a bug in ScriptedController which causes the ScriptedSequence
to skip over actions if the event of an Action_WaitForEvent is triggered
more than once in the same tick.

==UTAction_WaitForCondition==
by Wormbo
{{infobox class
| class = UTAction_WaitForEvent
| game = UT2004
| engine = UE2
| parent1 = ACTION_WaitForEvent
| custom = yes
}}

Waits exclusively for timer and unlike its superclass NOT for triggering.

==UTMaterialTrigger==
by Wormbo, originally named JBMaterialTrigger in the package 'JBToolbox'
{{infobox class
| class = UTMaterialTrigger
| parent1 = MaterialTrigger
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

MaterialTrigger that works properly in network games and also allows to reset materials.

See [[JDN:JBMaterialTrigger]] for more informations about this Actor.

==UTEmitterClientTriggerable==
by Wormbo, originally named JBEmitterClientTriggerable in the package 'JBToolbox'
{{infobox class
| class = UTEmitterClientTriggerable
| parent1 = Emitter
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Emitter that properly propagates Trigger() events to clients in network games. Otherwise it like a regular Emitter Actor.

See [[JDN:JBEmitterClientTriggerable]] for more informations about this Actor.

==ShadowProjectorPlaceable==
{{infobox class
| class = ShadowProjectorPlaceable
| game = UT2004
| engine = UE2
| parent1 = ShadowProjector
| custom = yes
}}

A fixed version of the ShadowProjector that works when manually placed in a map.

See [[User:Crusha/UltimateMappingTools/ShadowProjectorPlaceable|this page]] for more informations about this Actor.

==KarmaThing==
by unknown author
{{infobox class
| class = KarmaThing
| parent1 = KActor
| parent2 = Actor
| parent3 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This is a fixed version of the KActor that works in online games.

See [[User:Crusha/UltimateMappingTools/KarmaThing|this page]] for more informations about this Actor.

==OnlineCameraTextureClient==
by Maabus
{{infobox class
| class = OnlineCameraTextureClient
| parent1 = CameraTextureClient
| parent2 = Info
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Works exactly the same way as a normal CameraTextureClient, just that this one will also display dynamic Actors in netplay.

However, the camera will not change the way how an Actor is considered relevant to the local client, that means you can only see things on the camera that are relevant to you at that time. See [[udn2:ReplicationDeObfuscation|Relevant Actors]] to find out how an Actor gets relevant and [http://www.angelmapper.com/gamedev/tutorials/securitycamera.htm Angel Mapper's Tutorial] to find out how to set up a Security Cam.

==NetworkImportanceVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkImportanceVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

A Volume that forces any Actor inside it to be always relevant to the client for replication. Once the Actor leaves the Volume it will use it's default settings to determine the relevancy. This allows OnlineCameraTextureClients to display Actors that the client actually don't know about.

See [[User:Crusha/UltimateMappingTools/NetworkImportanceVolume|this page]] for more informations about this Actor.

==NetworkLinkedClientVolume==
by Crusha K. Rool
{{infobox class
| class = NetworkLinkedClientVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

Can be associated by a NetworkImportanceVolume to make that Volume only active if actual players are inside this Volume.

This should be used in the area from which a player can see an OnlineCameraTextureClient.
Makes only sense if that area is not very frequently visited by human players or fairly small and if the area of the NetworkImportanceVolume is the opposite of that.

==KarmaWakingVolume==
by Crusha K. Rool
{{infobox class
| class = KarmaWakingVolume
| parent1 = Volume
| parent2 = Brush
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Volume causes every Pawn or KActor subclasses in Phys_Karma or Phys_KarmaRagdoll state to perform their Karma calculations on every Tick instead of falling "asleep" if they aren't occupied by a player or waked by damage.

The purpose of this Volume is to enclose the area in which a Vehicle or KActor can be on a Mover, for example a vehicle lift. That will allow the lift to properly move the vehicle while it normally would simply stay at it's old location.

Use this only where it's necessary as it adds a constant strain of all enclosed Karma objects on the performance instead of using the automatic optimization.

=Mapping Assistance=
These tools are not really noticeable ingame but make a mapper's life a bit easier.

==PIEDPlayerStart==
by Crusha K. Rool
{{infobox class
| class = PIEDPlayerStart
| game = UT2004
| engine = UE2
| parent1 = PlayerStart
| custom = yes
}}

Placing one of these in the map will force the player to spawn at it,
disabling all other PlayerStarts in the meanwhile. That way can you quickly
check a certain position ingame during mapping without needing to walk there
from the regular startpoints all the time.
Just make sure to remove this when you are done.

==CullDistanceVolume==
by Crusha K. Rool, inspired by Epic
{{infobox class
| class = CullDistanceVolume
| game = UT2004
| engine = UE2
| parent1 = Volume
| custom = yes
}}

This catches up the idea of the CullDistanceVolume from UT3: At the beginning
of the match, all StaticMeshes are checked if their BoundingSphere's diameter
is smaller than the values in this array. Then they automatically get the
CullDistance set from these properties that match their size, thus allow to
quickly set up performance enhancements for the whole map.

See [[User:Crusha/UltimateMappingTools/CullDistanceVolume|this page]] for more information about this Actor.

=Pending Delete=
This stuff is no longer necessary since other toolsets have taken care of it already. (Blame the Worm, he can feel free to delete the linked pages of these sections as soon as he notices)

==NodeDamageGate==
by Crusha K. Rool
{{infobox class
| class = NodeDamageGate
| customparent1 = EventGate
| parent2 = Triggers
| parent3 = Actor
| parent4 = Object
| game = UT2004
| engine = UE2
| custom = yes
}}

This Actor deals a certain amount of damage to a PowerCore or PowerNode when being triggered.

See [[User:Crusha/UltimateMappingTools/NodeDamageGate|this page]] for more informations about this Actor.

[[Category:Mapping tools]]