Engine.WorldInfo

Extends

ZoneInfo

Modifiers

native config ( game ) hidecategories ( Actor , Advanced , Display , Events , Object , Attachment ) nativereplication notplaceable dependson ( PostProcessEffect ) dependson ( MusicTrackDataStructures )

WorldInfo Actor containing all script accessible world properties. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- Engine.ZoneInfo
         |   
         +-- Engine.WorldInfo

Functions Summary
		AllControllers (class<Controller> BaseClass, out Controller C)
		AllNavigationPoints (class<NavigationPoint> BaseClass, out NavigationPoint N)
		AllPawns (class<Pawn> BaseClass, out Pawn P, optional vector TestLocation, optional float TestRadius)
		CommitMapChange (optional bool bShouldSkipLevelStartupEvent=FALSE, ptional bool bShouldSkipLevelBeginningEvent=FALSE)
		ForceGarbageCollection ()
	string	GetAddressURL () con)
	EDetailMode	GetDetailMode ()
	class<GameInfo>	GetGameClass ()))
	Sequence	GetGameSequence () con)
	float	GetGravityZ ()
	string	GetLocalURL () con)
	MapInfo	GetMapInfo ()
	string	GetMapName (optional bool bIncludePrefix)
	bool	IsConsoleBuild (optional EConsoleType ConsoleType) con)
	bool	IsDemoBuild () con)
	bool	IsInSeamlessTravel ()
	bool	IsMapChangeReady ()
	bool	IsPlayInEditor () con)
	bool	IsPreparingMapChange ()
	bool	IsRecordingDemo ()
	bool	IsServer ()))
	bool	MapExists (string MapName)
		NavigationPointCheck (vector Point, vector Extent, optional out array<NavigationPoint> Navs, optional out array<ReachSpec> Specs)
		NotifyMatchStarted (optional bool bShouldActivateLevelStartupEvents=true, optional bool bShouldActivateLevelBeginningEvents=true, optional bool bShouldActivateLevelLoadedEvents=false)
		PostBeginPlay ()))
		PreBeginPlay ()))
		PrepareMapChange (const out array<name> LevelNames)
		RadiusNavigationPoints (class<NavigationPoint> BaseClass, out NavigationPoint N, vector Point, float Radius)
		Reset ()))
		SeamlessTravel (string URL, optional bool bAbsolute)
		ServerTravel (string URL, optional bool bAbsolute))
		SetLevelRBGravity (vector NewGrav)
		SetMapInfo (MapInfo NewMapInfo)
		SetSeamlessTravelMidpointPause (bool bNowPaused)
		ThisIsNeverExecuted (DefaultPhysicsVolume P))
		TravelFailed (string TravelURL, string Error, optional string ErrorCode))
		VerifyNavList ()

AudioTimeSeconds Source code

bAggressiveLOD Source code

bBegunPlay Source code

bDropDetail Source code

bHasPathNodes Source code

bHighPriorityLoading Source code

when this flag is set, more time is allocated to background loading (replicated)

bHighPriorityLoadingLocal Source code

copy of bHighPriorityLoading that is not replicated, for clientside-only loading operations

bMapHasPathingErrors Source code

This is a bool on the level which is set when the AI detects that paths are either not set up correctly or need to be rebuilt. If set the HUD will display a warning message on the screen.

bMapNeedsLightingFullyRebuilt Source code

This is a bool on the level which is set when a light that needs to have lighting rebuilt is moved. This is then checked in CheckMap for errors to let you know that this level should have lighting rebuilt.

bPathsRebuilt Source code

bPlayersOnly Source code

bRequestedBlockOnAsyncLoading Source code

Whether it was requested that the engine bring up a loading screen and block on async loading.

BSPVertex Source code

bStartup Source code

bUseConsoleInput Source code

Bool that indicates that 'console' input is desired. This flag is mis named as it is used for a lot of gameplay related things (e.g. increasing collision size, changing vehicle turning behavior, modifying put down/up weapon speed, bot behavior) currently set when you are running a console build (implicitly or explicitly via ?param on the commandline)

bWithinDemoPlayback Source code

Set during demo playback (WARNING: May not be reliable at the very start of demos, e.g. demo actors PostBeginPlay etc.)

CommittedLevelNames Source code

ComputerName Source code

ControllerList Source code

CoverList Source code

DecalManagerClassPath Source code

decal pool and lifetime manager

DefaultGravityZ Source code

DefaultTexture Source code

DeferredExecs Source code

This is the array of string which will be called after a tick has occurred. This allows functions which GC and/or delete objects to be executed from .uc land!

DeltaSeconds Source code

DemoPlayTimeDilation Source code

EmitterPoolClassPath Source code

particle emitter pool for gameplay effects that are spawned independent of their owning Actor

EngineVersion Source code

Game Source code

GRI Source code

HighestPriorityPostProcessVolume Source code

Linked list of post processing volumes, sorted in descending order of priority.

HighestPriorityReverbVolume Source code

Linked list of reverb volumes, sorted in descending order of priority.

LargeVertex Source code

LastMusicAction Source code

Kismet controlled music info (to inform newly joining clients)

LastMusicTrack Source code

LastTravelErrorCode Source code

LastTravelErrorURL Source code

MinNetVersion Source code

MoveRepSize Source code

MyDecalManager Source code

MyEmitterPool Source code

NavigationPointList Source code

NetMode Source code

NextSwitchCountdown Source code

NextURL Source code

PauseDelay Source code

Pauser Source code

PawnList Source code

PortalVolumes Source code

A array of portal volumes

PreparingLevelNames Source code

array of levels that were loaded into this map via PrepareMapChange() / CommitMapChange() (to inform newly joining clients)

RBPhysicsGravityScaling Source code

RealTimeSeconds Source code

RealTimeToUnPause Source code

ReplicationViewers Source code

valid only during replication - information about the player(s) being replicated to (there could be more than one in the case of a splitscreen client)

SelectedGroups Source code

TimeDilation Source code

TimeSeconds Source code

VisibleGroups Source code

WhiteSquareTexture Source code

WireframeTexture Source code

WorldGravityZ Source code

Editor

BookMarks[10] Source code

ClipPadEntries Source code

Physics

bPrimarySceneHW Source code

Primary PhysX scene runs on the PPU

bSupportDoubleBufferedPhysics Source code

Double buffered physics compartments enabled

CompartmentRunFrames Source code

Which compartments run on which frames (list is cyclic). An empty list means all compartments run on all frames.

MaxPhysicsDeltaTime Source code

The maximum frame time allowed for physics calculations

PhysicsTimings Source code

Timing parameters for the scene, primary and compartments.

WorldInfo

Author Source code

bNoDefaultInventoryForPlayer Source code

if true, do not grant player with default inventory (presumably, the LD's will be setting it manually)

bNoPathWarnings Source code

If true, don't add "no paths from" warnings to map error list in editor. Useful for maps that don't need AI support, but still have a few NavigationPoint actors in them.

DefaultColorScale Source code

Default color scale for the level

DefaultPostProcessSettings Source code

Default post process settings used by post processing volumes.

DefaultReverbSettings Source code

Default reverb settings used by reverb volumes.

GameTypesSupportedOnThisMap Source code

This is the list of GameTypes which this map can support. This is used for SeekFree loading code so the map has a reference to the game type it will be played with so it can cook all of the specific assets

GlobalGravityZ Source code

MyMapInfo Source code

game specific map information - access through GetMapInfo()/SetMapInfo()

PackedLightAndShadowMapTextureSize Source code

Maximum size of textures for packed light and shadow maps

SquintModeKernelSize Source code

Squint mode kernel size (same as DOF).

StallZ Source code

StreamingLevels Source code

Level collection. ULevels are referenced by FName (Package name) to avoid serialized references. Also contains offsets in world units

Title Source code

title of the map displayed in the UI

EConsoleType Source code

ENetMode Source code

CompartmentRunList Source code

For specifying which compartments should run on a given frame
Cloth:

The cloth compartment will run on this frame

Fluid:

The fluid compartment will run on this frame

RigidBody:

The rigid body compartment will run on this frame

SoftBody:

The soft body compartment will run on this frame

NetViewer Source code

stores information on a viewer that actors need to be checked against for relevancy

PhysXSceneTimings Source code

Timings for primary and compartments.
CompartmentTimingCloth:

Timing settings for the PhysX cloth compartment

CompartmentTimingFluid:

Timing settings for the PhysX fluid compartment

CompartmentTimingRigidBody:

Timing settings for the PhysX rigid body compartment

CompartmentTimingSoftBody:

Timing settings for the PhysX soft body compartment

PrimarySceneTiming:

Timing settings for the PhysX primary scene

PhysXTiming Source code

Timing parameters used for a PhysX primary scene or compartment
bFixedTimeStep:

If true, substep sizes are fixed equal to TimeStep. If false, substep sizes are varied to fit an integer number of times into the frame time.

MaxSubSteps:

The maximum number of substeps allowed per frame.

TimeStep:

The fixed or maximum substep size, depending on the value of bFixedTimeStep.

AllControllers Source code

returns all Controllers in the ControllerList that are of the specified class or a subclass
@note this function is only useful on the server; if you need the local player on a client, use Actor::LocalPlayerControllers()
@param BaseClass the base class of Controller to return
@param (out) C the returned Controller for each iteration

AllNavigationPoints Source code

returns all NavigationPoints in the NavigationPointList that are of the specified class or a subclass
@note this function cannot be used during level startup because the NavigationPointList is created in C++ ANavigationPoint::PreBeginPlay()
@param BaseClass the base class of NavigationPoint to return
@param (out) N the returned NavigationPoint for each iteration

AllPawns Source code

returns all Pawns in the PawnList that are of the specified class or a subclass
@note: useful on both client and server; pawns are added/removed from pawnlist in PostBeginPlay (on clients, only relevant pawns will be available)
@param BaseClass the base class of Pawn to return
@param (out) P the returned Pawn for each iteration
@param (optional) TestLocation is the world location used if TestRadius > 0
@param (optional) TestRadius is the radius checked against using TestLocation, skipping any pawns not within that value

CommitMapChange Source code

actually performs the map transition prepared by PrepareMapChange() it happens in the next tick to avoid GC issues if a map change is being prepared but isn't ready yet, the transition code will block until it is wait until IsMapChangeReady() returns true if this is undesired behavior

ForceGarbageCollection Source code

GetAddressURL Source code

GetDetailMode Source code

@return the current detail mode

GetGameClass Source code

GetGameSequence Source code

Grabs the default game sequence and returns it.
@return the default game sequence object

GetGravityZ Source code

Returns the Z component of the current world gravity and initializes it to the default gravity if called for the first time.
@return Z component of current world gravity.

GetLocalURL Source code

GetMapInfo Source code

@return the current MapInfo that should be used. May return one of the inner StreamingLevels' MapInfo if a streaming level transition has occurred via PrepareMapChange()

GetMapName Source code

@Returns the name of the current map

IsConsoleBuild Source code

Returns whether we are running on a console platform or on the PC.
@param ConsoleType - if specified, only returns true if we're running on the specified platform
@return TRUE if we're on a console, FALSE if we're running on a PC

IsDemoBuild Source code

IsInSeamlessTravel Source code

@return whether we're currently in a seamless transition

IsMapChangeReady Source code

if there is a map change being prepared, returns whether that change is ready to be committed (if no change is pending, always returns false)

IsPlayInEditor Source code

Returns whether script is executing within the editor.

IsPreparingMapChange Source code

returns whether there's a map change currently in progress

IsRecordingDemo Source code

@return whether a demo is being recorded

IsServer Source code

MapExists Source code

@return Returns true if the specified map file exists NOTE: Treats the input string as a URL, so it's safe to input "WAR-Torlan?LinkSetup=blah" etc.

NavigationPointCheck Source code

returns a list of NavigationPoints and ReachSpecs that intersect with the given point and extent
@param Point point to check
@param Extent box extent to check
@param (optional, out) Navs list of NavigationPoints that intersect
@param (optional, out) Specs list of ReachSpecs that intersect

NotifyMatchStarted Source code

Called by GameInfo.StartMatch, used to notify native classes of match startup (such as Kismet).

PostBeginPlay Source code

PreBeginPlay Source code

PrepareMapChange Source code

asynchronously loads the given levels in preparation for a streaming map transition. This codepath is designed for worlds that heavily use level streaming and gametypes where the game state should be preserved through a transition.
@param LevelNames the names of the level packages to load. LevelNames[0] will be the new persistent (primary) level

RadiusNavigationPoints Source code

returns all NavigationPoints whose cylinder intersects with a sphere of the specified radius at the specified point this function uses the navigation octree and is therefore fast for reasonably small radii
@note this function cannot be used during level startup because the navigation octree is populated in C++ ANavigationPoint::PreBeginPlay()
@param BaseClass the base class of NavigationPoint to return
@param (out) N the returned NavigationPoint for each iteration
@param Radius the radius to search in

Reset Source code

Reset actor to initial state - used when restarting level without reloading.

SeamlessTravel Source code

seamlessly travels to the given URL by first loading the entry level in the background, switching to it, and then loading the specified level. Does not disrupt network communication or disconnet clients. You may need to implement GameInfo::GetSeamlessTravelActorList(), PlayerController::GetSeamlessTravelActorList(), GameInfo::PostSeamlessTravel(), and/or GameInfo::HandleSeamlessTravelPlayer() to handle preserving any information that should be maintained (player teams, etc) This codepath is designed for worlds that use little or no level streaming and gametypes where the game state is reset/reloaded when transitioning. (like UT)
@param URL the URL to travel to; must be relative to the current URL (same server)

ServerTravel Source code

Jumps the server to new level. If bAbsolute is true and we are using seemless traveling, we will do an absolute travel (URL will be flushed).

SetLevelRBGravity Source code

SetMapInfo Source code

sets the current MapInfo to the passed in one

SetSeamlessTravelMidpointPause Source code

this function allows pausing the seamless travel in the middle, right before it starts loading the destination (i.e. while in the transition level) this gives the opportunity to perform any other loading tasks before the final transition this function has no effect if we have already started loading the destination (you will get a log warning if this is the case)
@param bNowPaused - whether the transition should now be paused

ThisIsNeverExecuted Source code

TravelFailed Source code

Called when the game fails to travel to a particular URL (NOTE: May not be called under all circumstances)
@param TravelURL: The URL which could not be travelled to
@param Error: The error message for the failed travel
@param ErrorCode: A 'code' for easily identifying specific travel errors in script

VerifyNavList Source code

defaultproperties
{
   DefaultPostProcessSettings=(bEnableBloom=True,bEnableSceneEffect=True,Bloom_Scale=0.200000,Bloom_InterpolationDuration=1.000000,DOF_FalloffExponent=4.000000,DOF_BlurKernelSize=12.000000,DOF_MaxFarBlurAmount=1.000000,DOF_ModulateBlurColor=(B=255,G=255,R=255,A=255),DOF_FocusInnerRadius=2000.000000,DOF_InterpolationDuration=1.000000,MotionBlur_MaxVelocity=1.000000,MotionBlur_Amount=0.500000,MotionBlur_FullMotionBlur=True,MotionBlur_CameraRotationThreshold=45.000000,MotionBlur_CameraTranslationThreshold=10000.000000,MotionBlur_InterpolationDuration=1.000000,Scene_HighLights=(X=1.000000,Y=1.000000,Z=1.000000),Scene_MidTones=(X=1.000000,Y=1.000000,Z=1.000000),Scene_InterpolationDuration=1.000000)
   SquintModeKernelSize=128.000000
   DefaultReverbSettings=(Volume=0.500000,FadeTime=2.000000)
   TimeDilation=1.000000
   DemoPlayTimeDilation=1.000000
   VisibleGroups="None"
   DefaultTexture=Texture2D'EngineResources.DefaultTexture'
   WhiteSquareTexture=Texture2D'EngineResources.WhiteSquareTexture'
   LargeVertex=Texture2D'EngineResources.LargeVertex'
   BSPVertex=Texture2D'EngineResources.BSPVertex'
   StallZ=1000000.000000
   DefaultGravityZ=-520.000000
   RBPhysicsGravityScaling=2.000000
   MoveRepSize=42.000000
   PackedLightAndShadowMapTextureSize=1024
   DefaultColorScale=(X=1.000000,Y=1.000000,Z=1.000000)
   LastMusicTrack=(Params=(FadeInTime=5.000000,FadeInVolumeLevel=1.000000,FadeOutTime=5.000000))
   EmitterPoolClassPath="UTGame.UTEmitterPool"
   DecalManagerClassPath="UTGame.UTDecalManager"
   MaxPhysicsDeltaTime=0.333333
   PhysicsTimings=(PrimarySceneTiming=(TimeStep=0.020000,MaxSubSteps=5),CompartmentTimingRigidBody=(TimeStep=0.020000,MaxSubSteps=2),CompartmentTimingFluid=(TimeStep=0.020000,MaxSubSteps=1),CompartmentTimingCloth=(bFixedTimeStep=True,TimeStep=0.020000,MaxSubSteps=2),CompartmentTimingSoftBody=(bFixedTimeStep=True,TimeStep=0.020000,MaxSubSteps=2))
   RemoteRole=ROLE_SimulatedProxy
   bWorldGeometry=True
   bAlwaysRelevant=True
   bBlockActors=True
   bHiddenEd=True
   Name="Default__WorldInfo"
   ObjectArchetype=ZoneInfo'Engine.Default__ZoneInfo'
}