Description

This package contains the Mutator SBMutatorFastWarShell for Unreal Tournament (UT99).

What it does

With my default INI settings every Redeemer fired by a Bot or Player has the high speed of 3000 instead of the default 600, a launch sound and message are broadcasted to the players and also a message is broadcasted if the projectile is destroyed by someone.

Comprehensive Description

If a WarHeadLauncher enters the game, the Mutator changes its projectiles if it has the default ones ("WarShell"/"GuidedWarshell"). Depending on the INI settings of bReplaceAllProjectileClasses and bReplaceAllAltProjectileClasses, projectiles are also replaced, if they are not the default ones.
When the weapon is fired - what means a projectile is spawned - the Mutator checks the instigator of the projectile: If it is one of the ValidWeaponInstigators, the speed of the projectile is set to the value of ProjectileSpeed given in the INI file. Also an optional launch sound is played, and a launch message as well as a message if the projectile was destroyed by someone can be broadcasted. Nothing is changed, if the instigator is not one of the desired, for example if it is an UMSSpaceMarine.
You can define up to eight ValidWeaponInstigators classes in the INI file for which these changes should be applied. Sub classes of these Actors are also included.

Ini file values

All settings are adjustable by editing the configuration file SBMutatorFastWarShell.ini. The settings are explained below.

Section SBMutatorFastWarShell

This section is for the Mutator itself.

Name	data type	default value	description
bDebug	bool	false	set it to TRUE for logging what Mutator does
bTreatWarHeadLauncherSubClasses	bool	false	set it to TRUE for treating sub classes of WarHeadLauncher also
bReplaceAllProjectileClasses	bool	false	set to TRUE if also other projectiles types beside `Class'WarShell'` should be replaced (see Projectile Replacements also)
bReplaceAllAltProjectileClasses	bool	false	set to TRUE if also other projectiles types beside `Class'GuidedWarShell'` should be replaced (see Projectile Replacements also)

Section SBWarShell

This section is for the WarShell.

Name	data type	default value	description
bDebug	bool	false	set it to TRUE for logging what Mutator does
ValidWeaponInstigators[0]	name	"PlayerPawn"	apply projectile modifications if instigator is a PlayerPawn
ValidWeaponInstigators[1]	name	"Bots"	apply projectile modifications if instigator is a Bots
ValidWeaponInstigators[2]	name	"Bot"	apply projectile modifications if instigator is a Bot
ValidWeaponInstigators[3...7]	name	(not defined)
ProjectileSpeed	float	3000	Speed of projectile. Should be equal or below ProjectileMaxSpeed.
ProjectileMaxSpeed	float	10000	Maximum speed of projectile (a WarShell is accelerated). Should be equal or above ProjectileSpeed.
LaunchMessage	string	"%k fired a Redeemer"	If not empty, this message is broadcasted on firing. See String Replacements also.
LaunchSoundName	string	"SBIncomingSndsV0.NuclearLaunchDetected"	If not empty, this sound is loaded and played for every player on firing.
ProjectileHealth	byte	5	If damage above this value is applied to the projectile, it gets destroyed.
bApplyFullDamage	bool	true	Apply full damage to a hit actor? Otherwise Actors with a huge collision cylinder won't be hurt by the explosion shock wave.
Destroymessage	string	"%o destroyed %k's Redeemer"	If not empty, this message is broadcasted if the projectile is destroyed. See String Replacements also.
UnknownDestroyerName	string	"Someone"	In case the projectile destroyer is already removed from level (imagine an already killed Brute, but his still flying rocket destroys the projectile), this name will be used instead of destroyer's name.
bDestroyedBroadcastMsg	bool	false	Display the Destroymessage as a normal broadcast message (that messages in the text box on top of HUD).
bDestroyedBroadcastMsgCritical	bool	true	Display the Destroymessage as a critical broadcast message (usually screen centered message).

Section SBGuidedWarShell

This section is for the guided WarShell.

Name	data type	default value	description
bDebug	(same as in SBWarShell)
ValidWeaponInstigators	(same as in SBWarShell)
ProjectileSpeed	float	600	Speed of the projectile. The maximum speed for it is set by code to the same value because this projectile does not accelerate. Warning: changing this value does not work proper on net play: projectile speed of client and server are different what results in stutting. I recommend not to change this if you use it on a server.
LaunchMessage	string	"%k started guiding a Redeemer"	(same as in SBWarShell)
LaunchSoundName	(same as in SBWarShell)
ProjectileHealth	(same as in SBWarShell)
bApplyFullDamage	bool	true	(same as in SBWarShell)
Destroymessage	string	"%o destroyed %k's guided Redeemer"	(same as in SBWarShell)
UnknownDestroyerName	(same as in SBWarShell)
bDestroyedBroadcastMsg	(same as in SBWarShell)
bDestroyedBroadcastMsgCritical	(same as in SBWarShell)

String Replacements

The following replacements are done in some strings:

%k	human readable name of projectile instigator
%o	human readable name of destroyer

Due to execution speed (and safety: image a player has the name "Pe%ky") only the first occurence of each is replaced. The letter case is respected (that means that %K or %O won't get replaced).

Sounds

The package comes with the three sounds NuclearLaunchDetected, SS_Incoming and Male2_Incoming in the file SBIncomingSndsV0.uax.
If you want one of these or another sound that is played for all players if the WarShell or GuidedWarshell is launched, enter the name of the sound in the ini file in the form Packagename.Soundname.
Example: LaunchSoundName="SBIncomingSndsV0.NuclearLaunchDetected"

If you run this Mutator locally, every sound should work. If you run it on a server, make sure that the sound package is available for the client (see ServerPackages below) and that the package does not have the flag "ServerSideOnly" - some stock files have it.

To disable sound, set the corresponding ini values to an empty string.

Pitfalls

Projectile Replacements

I left it as an option for the user to decide if sub classes of WarHeadLauncher are treated also - maybe a sub class has some code that relies on having a specific projectile class and will fail if that projectile is replaced. I recommend to stay with the default settings. With these settings only stock stuff is treated and things will work as expected.

Update

If you have a previous version of SBMutatorFastWarShell installed, you should remove the existing files SBMutatorFastWarShell*.* in the System folder of your UT installation before installing this version.

Installation (Client and Server)

Put the files

.\System\SBMutatorFastWarShell-V5.int
.\System\SBMutatorFastWarShell-V5.u
.\System\SBMutatorFastWarShell.ini

into the System folder of your UT installation. Change the values in SBMutatorFastWarShell.ini to your needs. If you want to use the sound package, add SBIncomingSndsV0.uax to the Sounds folder.

Installation on a Server

Add ServerPackages=SBMutatorFastWarShell-V5.u in Section [Engine.GameEngine] in UnrealTournament.ini. The default location of this file is in the System folder of your UT installation. If you want to use any sound package, add it there as well.
Add SBMutatorFastWarShell-V5.SBMutatorFastWarShell to the chain of your mutators. Details depends on server configuration and addons.

Installation on a Client

Start UT and choose the Mutator "SB Fast Redeemer Version 5" for a local game.

About

Autor

Name: Barbie
Contact: SeriousBarbie AT barbies DOT world

Copyright

This package is copyleft - do whatever you want.

Changelog

SBMutatorFastWarShell-V5, release 22 Mar 2023

Optionally beside the explosion shockwave the projectile applies its damage to the hit target.

Filelist
Name	Size	Date	MD5 sum
./Help/SBMutatorFastWarShell-Readme.htm	23027	2023-03-22	(this file)
./Sounds/SBIncomingSndsV0.uax	311367	2017-03-26	01c776a21d2b9bedd72da16f33362bdd
./Sourcecode/Classes/SBGuidedWarShell.uc	6719	2019-03-09	c760c2ddc40d31fee4fd2393ed910a1c
./Sourcecode/Classes/SBMutatorFastWarShell.uc	9783	2023-03-22	bee8d651e329baa696c7daecea6e4594
./Sourcecode/Classes/SBWarShell.uc	6481	2023-03-22	bc371e165afcc980b934db5bbda6aacb
./Sourcecode/make.ini	336	2023-03-22	9f3250ca86ecd58e1b7090d6045aa6cf
./Sourcecode/readme.txt	69	2016-01-09	65e1642a4cd5f397e424d0521cca2d42
./Sourcecode/Sounds/Male2_Incoming.wav	8506	2016-01-11	3514f3d101ba4970b4805051197a3b7f
./Sourcecode/Sounds/NuclearLaunchDetected.wav	180324	2015-09-11	12dc6a7ced08c637ef316303cf70668a
./Sourcecode/Sounds/SS_Incoming.wav	122220	2016-01-11	d2a942b31339808eb30f887d7552009b
./System/SBMutatorFastWarShell.ini	1175	2019-03-03	1fcdbfb36eb04516899b5d1c80cab39a
./System/SBMutatorFastWarShell-V5.int	208	2019-03-03	06f6d791e2d85f24bf297f908f4979bb
./System/SBMutatorFastWarShell-V5.u	37929	2023-03-22	e7f91b5028327297bff7ab3609c64079
./testing/Maps/TestSBMutatorFastWarShell.unr	13236	2019-03-09	102b7edd9fec455ab7bc8b38797229a7
./testing/RunTestmap.cmd	287	2023-03-22	f30927bd5f26be8861b9b4fc6f5c4085
./testing/Sounds/marine.uax	1688796	2006-10-20	4d71c18fe510ec2b514e154eb25bd29b
./testing/System/Adrenaline.u	79758	2014-05-31	ccd5efdcf9a57e5585eb13b1877a292c
./testing/System/umsspacemarine.u	7065808	2013-06-11	de066cc9064611eef019560162e692be

SBMutatorFastWarShell-V4, release 13 Apr 2017

Now the projectile's instigator instead of its owner is checked if projectile's properties should be changed.
added optional debugging
created package SBIncomingSndsV0.uax with some launching sounds

Filelist
Name	Size	Date	MD5 sum
./Help/SBMutatorFastWarShell-Readme.htm	19556	2017-04-13	d50df16bc16ed07e640d8792a9e5e6f3
./Sounds/SBIncomingSndsV0.uax	311367	2017-03-26	01c776a21d2b9bedd72da16f33362bdd
./Sourcecode/Classes/SBGuidedWarShell.uc	6041	2017-04-05	5ae1ebe01626ff190926322c857f4acf
./Sourcecode/Classes/SBMutatorFastWarShell.uc	9662	2017-03-28	a182a04c82efa8302159472a38fa52b7
./Sourcecode/Classes/SBWarShell.uc	5101	2017-04-04	ced675abad589c1e460aba253bbdfed0
./Sourcecode/make.ini	322	2016-08-02	a3d2527314eebb04084c7cc876f9fed9
./Sourcecode/readme.txt	69	2016-01-09	65e1642a4cd5f397e424d0521cca2d42
./Sourcecode/Sounds/Male2_Incoming.wav	8506	2016-01-11	3514f3d101ba4970b4805051197a3b7f
./Sourcecode/Sounds/NuclearLaunchDetected.wav	180324	2015-09-11	12dc6a7ced08c637ef316303cf70668a
./Sourcecode/Sounds/SS_Incoming.wav	122220	2016-01-11	d2a942b31339808eb30f887d7552009b
./System/SBMutatorFastWarShell.ini	1129	2017-04-05	3acb5e5827b0e0768ade1e4d9038597b
./System/SBMutatorFastWarShell-V4.int	208	2017-04-02	e903c37eeb7ff65d2d6553030c4ebefb
./System/SBMutatorFastWarShell-V4.u	34274	2017-04-04	8e299343f380cc9f602624dd66f9c5cf
./testing/Maps/TestSBMutatorFastWarShell.unr	8281	2017-03-26	2c5ac41fa6620896da498780f06823cf
./testing/RunTestmap.cmd	283	2017-03-26	9c2df14fd4d49ff2e04e9a4e44dc0983
./testing/Sounds/marine.uax	1688796	2006-10-20	4d71c18fe510ec2b514e154eb25bd29b
./testing/System/umsspacemarine.u	7065808	2013-06-11	de066cc9064611eef019560162e692be

SBMutatorFastWarShell-V3, no public release

added user option to treat sub classes of WarHeadLauncher also (bTreatWarHeadLauncherSubClasses)
added user option to replace all WarShells (bReplaceAllWarShells)
added user option to replace all GuidedWarShells (bReplaceAllGuidedWarShells)
added optional launch broadcast message
added optional destroyed broadcast message
moved shared code as static function into class SBMutatorFastWarShell

Filelist
Name	Size	Date	MD5 sum
./Help/SBMutatorFastWarShell-Example/Sounds/SBIncomingSnds.uax	130988	2016-01-11	47f18660ee0e0f9c0b4a0465514a2bb2
./Help/SBMutatorFastWarShell-Example/System/SBMutatorFastWarShell.ini	89	2016-01-11	2dc7fcd5b74013c8c728536a4a7aa953
./Help/SBMutatorFastWarShell-Readme.txt	6862	2016-07-30	2ab343175ec7b9a98e3fce9a2f0641b9
./redirect/SBMutatorFastWarShell-V3.u.uz	180049	2016-07-30	7593e2e64872fc7251554b47083fe853
./SBMutatorFastWarShell-md5sums.txt	1182	2016-01-11	934ec0d4958a098527ed3b1786ebb7bd
./Sourcecode/Classes/SBGuidedWarShell.uc	4077	2016-01-13	4da967eff2da2db2c1941e8ed36b04bb
./Sourcecode/Classes/SBMutatorFastWarShell.uc	8951	2016-07-30	2232c87b05c3ee43add45867831d7e13
./Sourcecode/Classes/SBWarShell.uc	1943	2016-01-11	5a3e3fad7bbdde5cdb7c93986a7dacd9
./Sourcecode/copyleft.txt	97	2015-10-02	ae5e178649b00957f4fe7af70b13bc75
./Sourcecode/make.ini	322	2016-07-21	93fb3041b0dd83ca8a2e0eb20853da80
./Sourcecode/readme.txt	69	2016-01-09	65e1642a4cd5f397e424d0521cca2d42
./Sourcecode/Sounds/Male2_Incoming.wav	8506	2016-01-11	3514f3d101ba4970b4805051197a3b7f
./Sourcecode/Sounds/NuclearLaunchDetected.wav	180324	2015-09-11	12dc6a7ced08c637ef316303cf70668a
./Sourcecode/Sounds/SS_Incoming.wav	122220	2016-01-11	d2a942b31339808eb30f887d7552009b
./System/SBMutatorFastWarShell.ini	1823	2016-07-21	20cae3b1692d46a6114c936364fdd959
./System/SBMutatorFastWarShell-V3.int	150	2016-01-08	6ba13ac9189b24e3467d1b97770a130d
./System/SBMutatorFastWarShell-V3.u	205115	2016-07-30	16de78d4a63ee1267165b0f6dbffaff1

SBMutatorFastWarShell-Rev2, 02 Oct 2015

SBWarShell was never faster than "Projectile.Default.MaxSpeed"(=2000). Fixed by making this configurable.
Added some sanity checks for the name of sound files in the ini file. A warning is logged if an error occurs.

Filelist
Name	Size	Date	MD5 sum
./copyleft.txt	97	2015-10-02	ae5e178649b00957f4fe7af70b13bc75
./Make.cmd	2193	2015-10-10	1d808e4be88a0a619a2b0a1432413bb7
./md5sums.txt	374	2015-09-17	1533179ef5ca8b9cc05d0cb8ee555109
./Readme.txt	2973	2015-10-02	3d27576e2eab2a43d0cb27b4f23ec09c
./redirect/SBMutatorFastWarShell-Rev2.u.uz	171176	2015-10-10	7885b73157ee7258575726397f2f7eec
./Sourcecode/Classes/SBGuidedWarShell.uc	1233	2015-10-02	2116661ac501c963fabe2483fdf6e10e
./Sourcecode/Classes/SBMutatorFastWarShell.uc	596	2015-10-02	24132da27ecfdb5e99d71e762fd4ed60
./Sourcecode/Classes/SBWarShell.uc	2227	2015-10-10	21098b9ab3da5d8ce4e315cdd7c8fac6
./Sourcecode/make.ini	626	2015-10-03	e461bdc9ab46b803731a800964c1c00b
./Sourcecode/Sounds/NuclearLaunchDetected.wav	180324	2015-09-11	12dc6a7ced08c637ef316303cf70668a
./System/SBMutatorFastWarShell.ini	667	2015-10-04	f1f8005bc55a198b0552651f06899d49
./System/SBMutatorFastWarShell-Rev2.int	147	2015-10-01	0465864d9f54f48f3d1f945fd407690d
./System/SBMutatorFastWarShell-Rev2.u	188100	2015-10-10	a4dd80af28c026306b70f1fdab34c520

SBMutatorFastWarShell-Rev1, 17 Sep 2015

added sound
added configuration by INI file
projectiles are only changed, if default projectiles

Filelist
Name	Size	Date	MD5 sum
./md5sums.txt	374	2015-09-17	1533179ef5ca8b9cc05d0cb8ee555109
./Readme.txt	2360	2015-09-17	37108b87a5cb0a5d08cd22d4bf2d8b25
./redirect/SBMutatorFastWarShell.u.uz	169270	2015-09-17	193b5fa6f7eb6f030fa976ec4039ee9b
./Sourcecode.7z	161212	2015-09-17	be19887b569ffd202d5175c7f12fd6fb
./System/SBMutatorFastWarShell.ini	557	2015-09-17	3e675cc1f1473afa660f741ec6b4e77a
./System/SBMutatorFastWarShell.int	134	2015-09-16	37ce310a88ee6e7c97fc73ab35f66f42
./System/SBMutatorFastWarShell.u	184894	2015-09-17	9d5180c2cc1d4b4533d4ebe48e68a08e

SBMutatorFastWarheadLauncher, 29 Aug 2015

first release