Cogito, ergo sum

UE2:Mutator (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 10:10, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UE2Runtime Object >> Actor >> Info >> Mutator
Package: 
Engine
This class in other games:
RTNP, U1, UT, U2XMP, U2, UT2003, UT2004, UT3, UDK

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[edit]

Property group 'Mutator'[edit]

Description[edit]

Type: string

Modifiers: localized


Default value: "Description"

FriendlyName[edit]

Type: string

Modifiers: localized


Default value: "Mutator"

GroupName[edit]

Type: string

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

Internal variables[edit]

bUserAdded[edit]

Type: bool


DefaultWeapon[edit]

Type: class<Weapon>


DefaultWeaponName[edit]

Type: string


NextMutator[edit]

Type: Mutator


Functions[edit]

Events[edit]

Destroyed[edit]

event Destroyed ()

Overrides: Actor.Destroyed


PreBeginPlay[edit]

event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


Other instance functions[edit]

AddMutator[edit]

function AddMutator (Mutator M)


AlwaysKeep[edit]

function bool AlwaysKeep (Actor Other)


CheckRelevance[edit]

function bool CheckRelevance (Actor Other)


CheckReplacement[edit]

function bool CheckReplacement (Actor Other, out byte bSuperRelevant)


GetDefaultWeapon[edit]

function class<WeaponGetDefaultWeapon ()


GetInventoryClass[edit]

function class<InventoryGetInventoryClass (string InventoryClassName)


GetInventoryClassOverride[edit]

function string GetInventoryClassOverride (string InventoryClassName)


GetServerDetails[edit]

function GetServerDetails (out Info.ServerResponseLine ServerState)


GetServerPlayers[edit]

function GetServerPlayers (out Info.ServerResponseLine ServerState)


IsRelevant[edit]

function bool IsRelevant (Actor Other, out byte bSuperRelevant)


ModifyLogin[edit]

function ModifyLogin (out string Portal, out string Options)


ModifyPlayer[edit]

function ModifyPlayer (Pawn Other)


Mutate[edit]

function Mutate (string MutateString, PlayerController Sender)


MutatorIsAllowed[edit]

function bool MutatorIsAllowed ()


MyDefaultWeapon[edit]

function class<WeaponMyDefaultWeapon ()


ParseChatPercVar[edit]

function string ParseChatPercVar (Controller Who, string Cmd)


PlayerChangedClass[edit]

function PlayerChangedClass (Controller aPlayer)


ReplaceWith[edit]

function bool ReplaceWith (Actor Other, string aClassName)


ServerTraveling[edit]

function ServerTraveling (string URL, bool bItems)