View source for User:Wormbo/OnslaughtSpecials

<div style="float:right;padding:0 0 1em 1em;">__TOC__</div>
The Onslaught Specials package contains some improved versions of Onslaught-specific actors. Below is a list of placeable actors and their new properties.

See [http://forum.omnipotents.com/showthread.php?t=13075 this thread] at the Omnip)o(tentS Forums for download and an example map.

==General usage considerations==
I recommend embedding the package in your map via the command <code>load file=OnslaughtSpecials2.u package=myLevel</code> at the UnrealEd console. Make sure it is not yet loaded when you use that command.

For consistency you should use ONSPowerCoreSpecial and ONSPowerNodeSpecial for either all or none of your power cores and nodes. The other classes have been generalized as much as possible, so they will also work correctly without the special power cores/nodes.

==Credits==
Thanks go out to:
*[[User:Crusha|Crusha K. Rool]] who started to create a bunch of useful mapping tools and not only inspired me to create this package, but also forwarded useful feedback from testers.
*[http://forums.epicgames.com/member.php?u=1323277 iwanpompier] who wrote the DirectionalNode, a power node class that works correctly even if not placed upright.

=Class descriptions=
==ACTION_DamagePowerNode==
{{infobox class
| class = ACTION_DamagePowerNode
| game = UT2004
| engine = UE2
| package = OnslaughtSpecials
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}
Damages a power node or core directly, even if it is protected or belongs to the instigator's team.

====bAttackNotification====
'''Type:''' [[bool]]

Whether to generate the regular attack notifications. (radar map, announcement)

'''Default value:''' True

====DamageAmount====
'''Type:''' [[int]]

How much health to remove from the node or core.

'''Default value:''' 100

====NodeTag====
'''Type:''' [[name]]

The node/core Tag name. Only the first matching node or core is damaged.

==ACTION_IfNodeShielded==
{{infobox class
| class = ACTION_IfNodeShielded
| game = UT2004
| engine = UE2
| package = OnslaughtSpecials
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}
Enters the following section only if the specified node is shielded.

====NodeTag====
'''Type:''' [[name]]

The node/core Tag name. Only the first matching node or core is checked.

==ACTION_IfSidesSwapped==
{{infobox class
| class = ACTION_IfSidesSwapped
| game = UT2004
| engine = UE2
| package = OnslaughtSpecials
| parent1 = ScriptedAction
| parent2 = Object
| custom = yes
}}
Enters the following section only if sides are switched on an Onslaught map.

====bSidesSwitched====
'''Type:''' [[bool]]

Whether the section should be executed when sides are swapped or when they are not.

'''Default value:''' True

==ForcedDirVolume==
{{infobox class
|class   = ForcedDirVolume
|package = OnslaughtSpecials
|game    = UT2004
|engine  = UE2
|custom  = yes
|parent1 = PhysicsVolume
|parent2 = Volume
|parent2 = Brush
|parent4 = Actor
|parent5 = Object
}}
A simple port of the [[UE3:ForcedDirVolume (UT3)|UT3 ForcedDirVolume]]. Since it doesn't support blocking other types of actors it is suggested to combine it with a [[UE2:BlockingVolume (UT2004)|BlockingVolume]] (or HitScanBlockingVolume) with bClassBlocker set to True and BlockedClasses containing UnrealPawn, PlayerController and Projectile (or at least TranslocatorBeacon) and whatever else mustn't enter that area.

====bDenyExit====
'''Type:''' [[bool]]

If set, drivers will not be able to exit the vehicle while it is affected by the volume.

====bDontBlockRedeemers====
'''Type:''' [[bool]]

If set, guided Redeemer missiles are allowed to pass through the volume unaffected. (default: False)

====TypeToForce====
'''Type:''' [[class]]<[[UE2:ONSVehicle (UT2004)|ONSVehicle]]>

The vehicle class to affect. Vehicles of this class or any subclass will be pushed by the volume. Set to <code>None</code> to disable effects on vehicles. (default: ONSVehicle)

====VehiclePushDir====
'''Type:''' [[vector]]

The push direction. Unfortunately there's no way to visualize this in the editor.

Alternatively you can set this to zero and modify Movement->Rotation instead. This will rotate the entire volume, but if you set Advanced->bDirectional=True you get an arrow at the volume's origin that points in the push direction.

====VehiclePushMag====
'''Type:''' [[float]]

How much to push vehicles and Redeemer missiles. (default: 4000.0)

==NodeWeaponLocker==
{{infobox class
|class   = NodeWeaponLocker
|package = OnslaughtSpecials
|game    = UT2004
|engine  = UE2
|custom  = yes
|parent1 = WeaponLocker
|parent2 = Pickup
|parent3 = Actor
|parent4 = Object
}}
A special version of the weapon locker that only provides weapons to players of the team owning the closest power node or core. You can add it to the ForcedCloseActors of an ONSPowerNodeSpecial or ONSPowerCoreSpecial to forcibly associate it with that particular node or core even if it's actually closer to another node or core.

====bNeutralIfNodeDisabled====
'''Type:''' [[bool]]

If set, the NodeWeaponLocker behaves like a regular weapon locker if the closest power node is disabled.

==ONSCountdownNode==
{{infobox class
|class         = ONSCountdownNode
|package       = OnslaughtSpecials
|game          = UT2004
|engine        = UE2
|custom        = yes
|customparent1 = ONSPowerNodeSpecial
|parent2       = ONSPowerNodeNeutral
|parent3       = ONSPowerNode
|parent4       = ONSPowerCore
|parent5       = DestroyableObjective
|parent6       = GameObjective
|parent7       = JumpSpot
|parent8       = JumpDest
|parent9       = NavigationPoint
|parent10      = Actor
|parent11      = Object
}}
Countdown functionality was merged into ONSPowerNodeSpecial. The countdown node class only still exists for compatibility reasons and can no longer be placed in UnrealEd.

==ONSPowerCoreSpecial==
{{infobox class
|class   = ONSPowerCoreSpecial
|package = OnslaughtSpecials
|game    = UT2004
|engine  = UE2
|custom  = yes
|parent1 = ONSPowerCore
|parent2 = DestroyableObjective
|parent3 = GameObjective
|parent4 = JumpSpot
|parent5 = JumpDest
|parent6 = NavigationPoint
|parent7 = Actor
|parent8 = Object
}}
A standard Onslaught power core with a few additional features. Custom node names can be set via [[UE2:GameObjective (UT2004)#ObjectiveName|GameObjective -> ObjectiveName]].

====bCoreBeamAlwaysUpright====
'''Type:''' [[bool]]

If the power core itself isn't upright (i.e. Rotation.Pitch/Roll changed), should its sky beam be?

====CoreHealth====
'''Type:''' [[int]]

How much health the core initially has. (default: 4500)

====ForcedCloseActors====
'''Type:''' [[array]]<[[name]]>

A list of actor names that should be associated with this core and not any other core or node. Any PlayerStart, ONSVehicleFactory, ONSStationaryWeaponPawn, ONSTeleportPad and xTeamBanner with a matching name or Tag will be affected.

==ONSPowerlinkOfficialSetupSupplement==
{{infobox class
| class = ONSPowerlinkOfficialSetupSupplement
| game = UT2004
| engine = UE2
| package = OnslaughtSpecials2
| parent1 = Actor
| parent2 = Object
| custom = yes
}}
Specifies additional information about an official link setup for the map.

====ActivatedActors====
'''Type:''' [[array]]<[[UE2:Actor (UT2004)|Actor]]>

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

Actors that should be activated in this link setup.

====ActivatedGroups====
'''Type:''' [[array]]<[[name]]>

Actor groups that should be activated in this link setup.

====CloseActorsOverrides====
'''Type:''' [[array]]<{{tl|TCloseActorsOverride}}>

Override settings for forced close actors.

====DeactivatedActors====
'''Type:''' [[array]]<[[UE2:Actor (UT2004)|Actor]]>

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

Actors that should be deactivated in this link setup.

====DeactivatedGroups====
'''Type:''' [[array]]<[[name]]>

Actor groups that should be deactivated in this link setup.

====PowernodeSettings====
'''Type:''' [[array]]<{{tl|TPowernodeSettings}}>

Additional information about nodes in this link setup.

====SetupName====
'''Type:''' [[string]]

The link setup name these options apply to.

==ONSPowerNodeSpecial==
{{infobox class
|class    = ONSPowerNodeSpecial
|package  = OnslaughtSpecials
|game     = UT2004
|engine   = UE2
|custom   = yes
|parent1  = ONSPowerNodeNeutral
|parent2  = ONSPowerNode
|parent3  = ONSPowerCore
|parent4  = DestroyableObjective
|parent5  = GameObjective
|parent6  = JumpSpot
|parent7  = JumpDest
|parent8  = NavigationPoint
|parent9  = Actor
|parent10 = Object
}}
This is a modified Onslaught power node with several additional features.

===Property group 'CountdownAnnouncements'===
====BuiltAnnouncements====
'''Type:''' [[array]]<{{tl|TAnnouncement}}>

Announcement to play when the node has finished construction.

'''Default value, index 0:''' 
{| class="list defaults"
! {{tl|TAnnouncement|||Member}}
! Value
|-
| AnnouncementSound
| [[UE2:Sound (UT2004)|Sound]]'A_StatusAnnouncer_RedControlsTheCountdownNode'
|-
| AnnouncementText
| "Red Controls the Countdown Node!"
|}

'''Default value, index 1:''' 
{| class="list defaults"
! {{tl|TAnnouncement|||Member}}
! Value
|-
| AnnouncementSound
| [[UE2:Sound (UT2004)|Sound]]'A_StatusAnnouncer_BlueControlsTheCountdownNode'
|-
| AnnouncementText
| "Blue Controls the Countdown Node!"
|}

====DestroyedAnnouncements====
'''Type:''' [[array]]<{{tl|TAnnouncement}}>

Announcement to play when the node was destroyed before the countdown completed.

'''Default value:''' 
{| class="list defaults"
! {{tl|TAnnouncement|||Member}}
! Value
|-
| AnnouncementSound
| [[UE2:Sound (UT2004)|Sound]]'A_StatusAnnouncer_CountdownNodeDestroyed'
|-
| AnnouncementText
| "Countdown Node Destroyed"
|}

====HalfTimeAnnouncements====
'''Type:''' [[array]]<{{tl|TAnnouncement}}>

Announcement to play when half of the node's countdown time has passed.

====SuccessAnnouncements====
'''Type:''' [[array]]<{{tl|TAnnouncement}}>

Announcement to play when the countdown has completed.

'''Default value, index 0:''' 
{| class="list defaults"
! {{tl|TAnnouncement|||Member}}
! Value
|-
| AnnouncementText
| "Red Countdown Node Completed!"
|}

'''Default value, index 1:''' 
{| class="list defaults"
! {{tl|TAnnouncement|||Member}}
! Value
|-
| AnnouncementText
| "Blue Countdown Node Completed!"
|}

====TenSecondsLeftAnnouncements====
'''Type:''' [[array]]<{{tl|TAnnouncement}}>

Announcement to play when only ten seconds of the countdown time are left.

===Property group 'CountdownEvents'===
====BlueCompletedEvent====
'''Type:''' [[name]]

Event to trigger when the blue team completes the countdown.

====RedCompletedEvent====
'''Type:''' [[name]]

Event to trigger when the red team completes the countdown.

===Property group 'ONSPowerNodeSpecial'===
====bCatchLinkBeamEnd====
'''Type:''' [[bool]]

Whether to hold on to a link beam, similar to players and vehicles.

'''Default value:''' True

====bNodeBeamAlwaysUpright====
'''Type:''' [[bool]]

If the node is not upright, should its skybeam be?

====bSphereBlocksPlayers====
'''Type:''' [[bool]]

Whether players are blocked by the rotating energy sphere above an active node.

'''Default value:''' True

====bUntriggerActivationEvent====
'''Type:''' [[bool]]

Whether the construction event should be untriggered when the node is destroyed.

'''Default value:''' True

====ForcedCloseActors====
'''Type:''' [[array]]<[[UE2:Actor (UT2004)|Actor]]>

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

A list of vehicle factories, turrets, playerstarts, teleporter pads, team
banners, node weapon lockers and other compatible actors, that should be
considered closest to this node even if other nodes are actually closer.
(You should use only special nodes/cores for this feature to work properly.)

====ForcedCloseActorTags====
'''Type:''' [[array]]<[[name]]>

Matching actors are added to the ForcedCloseActors list.

====IsolatedDamagePerSec====
'''Type:''' [[int]]

How much damage this node takes while it's isolated.

'''Default value:''' 30

====LinkHealMultiplier====
'''Type:''' [[float]]

Multiplier for linkgun healing.

'''Default value:''' 1.0

====NodeHealth====
'''Type:''' [[int]]

The node's health.

'''Default value:''' 2000

====ShieldedHealingPerSec====
'''Type:''' [[int]]

The node will regenerate this many hitpoints per second while it is shielded.

====SphereHeight====
'''Type:''' [[float]]

How high above the node should the energy sphere be?

'''Default value:''' 370.0

==ONSWithTranslocator==
{{infobox class
| class = ONSWithTranslocator
| game = UT2004
| engine = UE2
| package = OnslaughtSpecials2
| parent1 = Info
| parent2 = Actor
| parent3 = Object
| custom = yes
}}
Forcibly enables the [[liandri:Translocator|Translocator]] in this map. Can be disabled for specific
link setups via link setup supplements. It is recommended to use the Translocator as replacement for vehicles, not in addition to them.

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

Whether Translocator is enabled by default.

'''Default value:''' True

==TriggeredWeaponBase==
{{infobox class
| class = TriggeredWeaponBase
| game = UT2004
| engine = UE2
| package = OnslaughtSpecials2
| parent1 = xWeaponBase
| parent2 = xPickUpBase
| parent3 = Actor
| parent4 = Object
| custom = yes
}}
A weapon pickup base that only spawns a weapon when triggered.

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

Should the weapon respawn automatically after being picked up? If not, the pickup base deactivates automatically after the weapon was picked up.

===States===
====TriggerControl====
Triggering activates the weapon base, untriggering or reset deactivates it.

====TriggerToggle====
Triggering activates the weapon base, triggering again or reset deactivates it.

====TriggerTurnOn====
Triggering activates the weapon base, reset deactivates it.

==xTeamMaterialSwitch==
{{infobox class
|class   = xTeamMaterialSwitch
|package = OnslaughtSpecials
|game    = UT2004
|engine  = UE2
|custom  = yes
|parent1 = xTeamBanner
|parent2 = Decoration
|parent3 = Actor
|parent4 = Object
}}
Creates a [[UE2:MaterialSwitch (UT2004)|MaterialSwitch]] with 4 materials and picks a material based on who owns the associated node or core. 

====MaterialSwitch====
'''Type:''' [[UE2:MaterialSwitch (UT2004)|MaterialSwitch]]

The MaterialSwitch to assign the various materials to. Whenever you create or duplicate a xTeamMaterialSwitch actor, a new MaterialSwitch object will be created to prevent conflicts with other xTeamMaterialSwitchs. The default MaterialSwitch contains 4 materials (0: red, 1: blue, 2: neutral, 3: disabled).

====TeamSymbolCombiners====
'''Type:''' [[UE2:Combiner (UT2004)|Combiner]]

'''[[Static arrays|Array size]]:''' 2

Combiners to assign the owning team's symbol to. (index 0: red, index 1: blue) The symbol texture will be assigned to Material2 of the corresponding Combiner when a team owns the node. It will not be removed again if the node is destroyed or taken by another team.

==xTeamMonitor==
{{infobox class
|class   = xTeamMonitor
|package = OnslaughtSpecials
|game    = UT2004
|engine  = UE2
|custom  = yes
|parent1 = xTeamBanner
|parent2 = Decoration
|parent3 = Actor
|parent4 = Object
}}
An Onslaught-compatible version of the [[UE2:xMonitor (UT2004)|xMonitor]]. 

====BlueTeamShader====
'''Type:''' [[UE2:Material (UT2004)|Material]]

Material to use as [[UE2:Actor properties (UT2004)#Skins|Skins]][2] while the blue team owns the node.

====DisabledShader====
'''Type:''' [[UE2:Material (UT2004)|Material]]

Material to use as [[UE2:Actor properties (UT2004)#Skins|Skins]][2] while the node is disabled.

====NeutralShader====
'''Type:''' [[UE2:Material (UT2004)|Material]]

Material to use as [[UE2:Actor properties (UT2004)#Skins|Skins]][2] while no team owns the node.

====RedTeamShader====
'''Type:''' [[UE2:Material (UT2004)|Material]]

Material to use as [[UE2:Actor properties (UT2004)#Skins|Skins]][2] while the red team owns the node.

====TeamSymbolCombiners====
'''Type:''' [[UE2:Combiner (UT2004)|Combiner]]

'''[[Static arrays|Array size]]:''' 2

Combiners to assign the owning team's symbol to. (index 0: red, index 1: blue) The symbol texture will be assigned to Material2 of the corresponding Combiner when a team owns the node. It will not be removed again if the node is destroyed or taken by another team.

==Structs==
===TAnnouncement===
Describes an announcement for a countdown node.
; [[UE2:Sound (UT2004)|Sound]] AnnouncementSound : An announcement sound to play.
; [[name]] AnnouncementName : Name of an announcement to play. This will be ignored if an announcement sound is set.
; [[string]] AnnouncementText : A [[localized]] text to display on the HUD as part of the announcement.

===TCloseActorsOverride===
Close actors override for a single actor in the map.
; [[UE2:Actor (UT2004)|Actor]] Actor : The actor to associate with a different node or core.
; [[UE2:ONSPowerCore (UT2004)|ONSPowerCore]] ClosestNode : The node or core to associate the actor with.
Only works with special cores and nodes, including countdown nodes.

===TPowernodeSettings===
Information about a single power node.
; {{cl|ONSPowerNodeSpecial}} Node : The power node to apply these settings to.
; [[UE2:ONSPowerCore (UT2004)|ONSPowerCore]] OwnerCore : The power core of the team initially owning this node.
(This doesn't receive any further checks, so you could create isolated
nodes that will die soon after the match started.)
; [[bool]] bIsStandalone : Whether the node should stay active even if it's not connected to the main
power network. If this is applied to a networked node, the node can always
be captured and attacked by both teams and will power other connected nodes
even without a direct link from any power core.
; [[bool]] bNeverShielded : Whether the node can always be attacked by the enemy team.
; [[bool]] bNotShieldedIfIsolated : Whether the node becomes attackable when it gets isolated.
; [[bool]] bKeepVehiclesWhenDestroyed : Whether nearby vehicles should stay around if the node is destroyed.
; [[byte]] MinPlayerCount : The minimum player count required to activate this power node.
The node will be disabled and potentially removed from the
network if less players are in the game.
; [[bool]] bCountdownDamagesEnemyCore : AI hint that a successful countdown will damage the enemy team's power core.
; [[name]] RedCompletedEvent : Event to trigger when the red team completes the countdown.
; [[name]] BlueCompletedEvent : Event to trigger when the blue team completes the countdown.
; [[byte]] CountdownTime : How long the node must be held for the countdown to complete.
; [[bool]] bStopCountdownIfIsolated : Should the countdown stop if the node is isolated while not standalone?
; [[array]]<{{tl|TAnnouncement|ONSPowerNodeSpecial}}> BuiltAnnouncements : Announcement to play when the node has finished construction.
; [[array]]<{{tl|TAnnouncement|ONSPowerNodeSpecial}}> HalfTimeAnnouncements : Announcement to play when half of the node's countdown time has passed.
; [[array]]<{{tl|TAnnouncement|ONSPowerNodeSpecial}}> TenSecondsLeftAnnouncements : Announcement to play when only ten seconds of the countdown time are left.
; [[array]]<{{tl|TAnnouncement|ONSPowerNodeSpecial}}> SuccessAnnouncements : Announcement to play when the countdown has completed.
; [[array]]<{{tl|TAnnouncement|ONSPowerNodeSpecial}}> DestroyedAnnouncements : Announcement to play when the node was destroyed before the countdown completed.

{{DEFAULTSORT:{{SUBPAGENAME}}}}[[Category:Mapping tools]]