UE2:Mutator (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 10:11, 17 May 2008 by Wormbo (talk | contribs) (Auto-generated page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
UT2004 Object >> Actor >> Info >> Mutator
Package:
Engine
Direct subclasses:
MutGameSpeed, MutBonusVehicles, DMMutator, MutMovementModifier, MutArena, MutBerserk, MutBigHead, MutBigWheels, MutCrateCombo, MutFastWeapSwitch, MutInstaGib, MutLightweightVehicles, MutLowGrav, MutNoAdrenaline, MutNoSuperWeapon, MutOnslaughtWeapons, MutQuadJump, MutRegen, MutSlomoDeath, MutSpeciesStats, MutUDamageReward, MutUseLightning, MutUTClassic, MutUseSniper, MutVampire, MutVehicleArena, MutVehiclePickups, MutWheeledVehicleStunts, UtvMutator
Known custom subclass:
Eliot/LevelConfigManager
This class in other games:

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.

Properties

Property group 'Mutator'

ConfigMenuClassName

Type: string

Modifiers: cache


Description

Type: string

Modifiers: localized, cache


FriendlyName

Type: string

Modifiers: localized, cache


GroupName

Type: string

Modifiers: cache

Will only allow one mutator with this tag to be selected.

IconMaterialName

Type: string

Modifiers: cache


Default value: "MutatorArt.nosym"

Internal variables

bAddToServerPackages

Type: bool

if true, the package this mutator is in will be added to serverpackages at load time

bUserAdded

Type: bool

mc - mutator was added by user (cmdline or mutator list)

DefaultWeapon

Type: class<Weapon>


DefaultWeaponName

Type: string


NextMutator

Type: Mutator


Functions

Events

Destroyed

event Destroyed ()

Overrides: Actor.Destroyed


OverrideDownload

event bool OverrideDownload (string PlayerIP, string PlayerID, string PlayerURL, out string RedirectURL)


PreBeginPlay

event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


Other instance functions

AddMutator

function AddMutator (Mutator M)


AlwaysKeep

function bool AlwaysKeep (Actor Other)


CanEnterVehicle

function bool CanEnterVehicle (Vehicle V, Pawn P)


CanLeaveVehicle

function bool CanLeaveVehicle (Vehicle V, Pawn P)


CheckRelevance

function bool CheckRelevance (Actor Other)


CheckReplacement

function bool CheckReplacement (Actor Other, out byte bSuperRelevant)


DriverEnteredVehicle

function DriverEnteredVehicle (Vehicle V, Pawn P)


DriverLeftVehicle

function DriverLeftVehicle (Vehicle V, Pawn P)


GetDefaultWeapon

function class<WeaponGetDefaultWeapon ()


GetInventoryClass

function class<InventoryGetInventoryClass (string InventoryClassName)


GetInventoryClassOverride

function string GetInventoryClassOverride (string InventoryClassName)


GetServerDetails

function GetServerDetails (out GameInfo.ServerResponseLine ServerState)


GetServerPlayers

function GetServerPlayers (out GameInfo.ServerResponseLine ServerState)


IsRelevant

function bool IsRelevant (Actor Other, out byte bSuperRelevant)


ModifyLogin

function ModifyLogin (out string Portal, out string Options)


ModifyPlayer

function ModifyPlayer (Pawn Other)


Mutate

function Mutate (string MutateString, PlayerController Sender)


MutatorFillPlayInfo

function MutatorFillPlayInfo (PlayInfo PlayInfo)


MutatorIsAllowed

function bool MutatorIsAllowed ()


MyDefaultWeapon

function class<WeaponMyDefaultWeapon ()


NewRecommendCombo

function string NewRecommendCombo (string ComboName, AIController C)


NotifyLogout

function NotifyLogout (Controller Exiting)


ParseChatPercVar

function string ParseChatPercVar (Controller Who, string Cmd)


PlayerChangedClass

function PlayerChangedClass (Controller aPlayer)


RecommendCombo

function string RecommendCombo (string ComboName)


ReplaceWith

function bool ReplaceWith (Actor Other, string aClassName)


ServerTraveling

function ServerTraveling (string URL, bool bItems)