Cogito, ergo sum

UE3:Mutator (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Actor >> Info >> Mutator
Package: 
Engine
Direct subclass:
UTMutator
This class in other games:
RTNP, U1, UT, U2XMP, U2, UE2Runtime, UT2003, UT2004, 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(), 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. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties[edit]

Property group 'Mutator'[edit]

GroupNames[edit]

Type: array<string>

list of groups this mutator is in. Mutators that share any group cannot be activated simultaneously

Internal variables[edit]

bUserAdded[edit]

Type: bool


NextMutator[edit]

Type: Mutator


Default values[edit]

Property Value
CollisionType COLLIDE_CustomDefault

Subobjects[edit]

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

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)


AllowBecomeActivePlayer[edit]

function bool AllowBecomeActivePlayer (PlayerController P)


AllowBecomeSpectator[edit]

function bool AllowBecomeSpectator (PlayerController P)


AllowChangeTeam[edit]

function bool AllowChangeTeam (Controller Other, out int num, bool bNewTeam)


AlwaysKeep[edit]

function bool AlwaysKeep (Actor Other)


CanLeaveVehicle[edit]

function bool CanLeaveVehicle (Vehicle V, Pawn P)


CheckRelevance[edit]

function bool CheckRelevance (Actor Other)


CheckReplacement[edit]

function bool CheckReplacement (Actor Other)

Returns true to keep this actor

DriverEnteredVehicle[edit]

function DriverEnteredVehicle (Vehicle V, Pawn P)


DriverLeftVehicle[edit]

function DriverLeftVehicle (Vehicle V, Pawn P)


GetSeamlessTravelActorList[edit]

function GetSeamlessTravelActorList (bool bToEntry, out array<ActorActorList)

called on the server during seamless level transitions to get the list of Actors that should be moved into the new level PlayerControllers, Role < ROLE_Authority Actors, and any non-Actors that are inside an Actor that is in the list (i.e. Object.Outer == Actor in the list) are all automatically moved regardless of whether they're included here only dynamic (!bStatic and !bNoDelete) actors in the PersistentLevel may be moved (this includes all actors spawned during gameplay) this is called for both parts of the transition because actors might change while in the middle (e.g. players might join or leave the game)

Parameters:

  • bToEntry - true if we are going from old level -> entry, false if we are going from entry -> new level
  • ActorList - out) list of actors to maintain

GetServerDetails[edit]

function GetServerDetails (out Info.ServerResponseLine ServerState)


GetServerPlayers[edit]

function GetServerPlayers (out Info.ServerResponseLine ServerState)


InitMutator[edit]

function InitMutator (string Options, out string ErrorMessage)

This function can be used to parse the command line parameters when a server starts up

IsRelevant[edit]

function bool IsRelevant (Actor Other)


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 ()


NotifyBecomeActivePlayer[edit]

function NotifyBecomeActivePlayer (PlayerController Player)


NotifyBecomeSpectator[edit]

function NotifyBecomeSpectator (PlayerController Player)


NotifyLogin[edit]

function NotifyLogin (Controller NewPlayer)


NotifyLogout[edit]

function NotifyLogout (Controller Exiting)


NotifySetTeam[edit]

function NotifySetTeam (Controller Other, TeamInfo OldTeam, TeamInfo NewTeam, bool bNewTeam)


ParseChatPercVar[edit]

function string ParseChatPercVar (Controller Who, string Cmd)