I love the smell of UnrealEd crashing in the morning. – tarquin
UE2:Mutator (UT2004)
From Unreal Wiki, The Unreal Engine Documentation Site
- Package:
- Engine
- Direct subclasses:
- DMMutator, MutArena, MutBerserk, MutBigHead, MutBigWheels, MutBonusVehicles, MutCrateCombo, MutFastWeapSwitch, MutGameSpeed, MutInstaGib, MutLightweightVehicles, MutLowGrav, MutMovementModifier, MutNoAdrenaline, MutNoSuperWeapon, MutOnslaughtWeapons, MutQuadJump, MutRegen, MutSlomoDeath, MutSpeciesStats, MutUDamageReward, MutUTClassic, MutUseLightning, MutUseSniper, MutVampire, MutVehicleArena, MutVehiclePickups, MutWheeledVehicleStunts, UtvMutator
- This class in other games:
- RTNP, U1, U2, U2XMP, UDK, UE2Runtime, UT, UT2003, UT3
| This is an auto-generated page and may need human attention. Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Mutator.
Mutators allow modifications to gameplay while keeping the game rules intact. Mutators are given the opportunity to modify player login parameters with ModifyLogin(), to modify player pawn properties with ModifyPlayer(), to change the default weapon for players with GetDefaultWeapon(), or to modify, remove, or replace all other actors when they are spawned with CheckRelevance(), which is called from the PreBeginPlay() function of all actors except those (Decals, Effects and Projectiles for performance reasons) which have bGameRelevant==true.
[edit] Properties
[edit] Property group 'Mutator'
[edit] ConfigMenuClassName
Type: string
Modifiers: cache
[edit] Description
Type: string
Modifiers: localized, cache
[edit] FriendlyName
Type: string
Modifiers: localized, cache
[edit] GroupName
Type: string
Modifiers: cache
Will only allow one mutator with this tag to be selected.
[edit] IconMaterialName
Type: string
Modifiers: cache
Default value: "MutatorArt.nosym"
[edit] Internal variables
[edit] bAddToServerPackages
Type: bool
if true, the package this mutator is in will be added to serverpackages at load time
[edit] bUserAdded
Type: bool
mc - mutator was added by user (cmdline or mutator list)
[edit] DefaultWeapon
[edit] DefaultWeaponName
Type: string
[edit] NextMutator
Type: Mutator
[edit] Functions
[edit] Events
[edit] Destroyed
Overrides: Actor.Destroyed
[edit] OverrideDownload
[edit] PreBeginPlay
Overrides: Actor.PreBeginPlay
[edit] Other instance functions
[edit] AddMutator
[edit] AlwaysKeep
[edit] CanEnterVehicle
[edit] CanLeaveVehicle
[edit] CheckRelevance
[edit] CheckReplacement
[edit] DriverEnteredVehicle
[edit] DriverLeftVehicle
[edit] GetDefaultWeapon
[edit] GetInventoryClass
[edit] GetInventoryClassOverride
[edit] GetServerDetails
[edit] GetServerPlayers
[edit] IsRelevant
[edit] ModifyLogin
[edit] ModifyPlayer
[edit] Mutate
Called by a PlayerController when the player executes a "mutate" console command. Everything after the command name "mutate" is passed to this function as a raw string, which you will have to parse yourself. Keep in mind that this function is called for every possible mutate command a player may use, so make sure you always call Super.Mutate(MutateString, Sender); to ensure all other mutators get a chance to parse their mutate commands. Always make sure Sender is not None. (see below)
Note: The SafeGame anti-cheat mod introduced an unofficial protocol for player kick notifications that is based on this Mutate function with the Sender parameter being None. According to this protocol, which is also used or recognized by other mods, such as the UTAN mutator or Anti TCC, kick notifications can be sent to all mutators by using a MutateString formatted as follows:
KickedBy parameters
The parameters string contains the following fields, which are separated by the character that is returned by Chr(254):
- Mod name: This is the name of the mod that kicked a player, for example SafeGame, AntiTCC or UTAN.
- Player name: The exact, current name of the player being kicked.
- Zero or more other parameters: These are separated by Chr(254) as well and their meaning depends on the mod.
For UTAN this is the ban ID, SafeGame and AntiTCC put details such as the GUID, IP and other player-specific information here, as well as a kick reason.
