UE3:Mutator (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

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.

[edit] Properties

[edit] Property group 'Mutator'

[edit] GroupNames

Type: array<string>

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

[edit] Internal variables

[edit] bUserAdded

Type: bool

[edit] NextMutator

Type: Mutator

[edit] Default values

Property	Value
CollisionType	COLLIDE_CustomDefault

[edit] Subobjects

[edit] Sprite

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

[edit] Functions

[edit] Events

[edit] Destroyed

event Destroyed ()

Overrides: Actor.Destroyed

[edit] PreBeginPlay

event PreBeginPlay ()

Overrides: Actor.PreBeginPlay

[edit] Other instance functions

[edit] AddMutator

function AddMutator (Mutator M)

[edit] AllowBecomeActivePlayer

function bool AllowBecomeActivePlayer (PlayerController P)

[edit] AllowBecomeSpectator

function bool AllowBecomeSpectator (PlayerController P)

[edit] AllowChangeTeam

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

[edit] AlwaysKeep

function bool AlwaysKeep (Actor Other)

[edit] CanLeaveVehicle

function bool CanLeaveVehicle (Vehicle V, Pawn P)

[edit] CheckRelevance

function bool CheckRelevance (Actor Other)

[edit] CheckReplacement

function bool CheckReplacement (Actor Other)

Returns true to keep this actor

[edit] DriverEnteredVehicle

function DriverEnteredVehicle (Vehicle V, Pawn P)

[edit] DriverLeftVehicle

function DriverLeftVehicle (Vehicle V, Pawn P)

[edit] GetSeamlessTravelActorList

function GetSeamlessTravelActorList (bool bToEntry, out array<Actor> ActorList)

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

[edit] GetServerDetails

function GetServerDetails (out Info.ServerResponseLine ServerState)

[edit] GetServerPlayers

function GetServerPlayers (out Info.ServerResponseLine ServerState)

[edit] InitMutator

function InitMutator (string Options, out string ErrorMessage)

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

[edit] IsRelevant

function bool IsRelevant (Actor Other)

[edit] ModifyLogin

function ModifyLogin (out string Portal, out string Options)

[edit] ModifyPlayer

function ModifyPlayer (Pawn Other)

[edit] Mutate

function Mutate (string MutateString, PlayerController Sender)

[edit] MutatorIsAllowed

function bool MutatorIsAllowed ()

[edit] NotifyBecomeActivePlayer

function NotifyBecomeActivePlayer (PlayerController Player)

[edit] NotifyBecomeSpectator

function NotifyBecomeSpectator (PlayerController Player)

[edit] NotifyLogin

function NotifyLogin (Controller NewPlayer)

[edit] NotifyLogout

function NotifyLogout (Controller Exiting)

[edit] NotifySetTeam

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

[edit] ParseChatPercVar

function string ParseChatPercVar (Controller Who, string Cmd)