Class GameStateBase

GameStateBase is a class that manages the game's global state, and is spawned by GameModeBase.

Inheritance
System.Object
UObject
Actor
Info
GameStateBase
GameState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class GameStateBase : Info
Remarks

It exists on both the client and the server and is fully replicated.

Properties

| Improve this Doc View Source

AuthorityGameMode

Instance of the current game mode, exists only on the server. For non-authority clients, this will be NULL.

Declaration
public GameModeBase AuthorityGameMode { get; }
Property Value
Type Description
GameModeBase
| Improve this Doc View Source

bReplicatedHasBegunPlay

Declaration
public bool bReplicatedHasBegunPlay { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static GameStateBase DefaultObject { get; }
Property Value
Type Description
GameStateBase
| Improve this Doc View Source

GameModeClass

Class of the server's game mode, assigned by GameModeBase.

Declaration
public SubclassOf<GameModeBase> GameModeClass { get; }
Property Value
Type Description
SubclassOf<GameModeBase>
| Improve this Doc View Source

PlayerArray

Array of all PlayerStates, maintained on both server and clients (PlayerStates are always relevant)

Declaration
public ObjectArrayField<PlayerState> PlayerArray { get; }
Property Value
Type Description
ObjectArrayField<PlayerState>
| Improve this Doc View Source

ReplicatedWorldTimeSeconds

Server TimeSeconds. Useful for syncing up animation and gameplay.

Declaration
public float ReplicatedWorldTimeSeconds { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ServerWorldTimeSecondsDelta

The difference from the local world's TimeSeconds and the server world's TimeSeconds.

Declaration
public float ServerWorldTimeSecondsDelta { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ServerWorldTimeSecondsUpdateFrequency

Frequency that the server updates the replicated TimeSeconds from the world. Set to zero to disable periodic updates.

Declaration
public float ServerWorldTimeSecondsUpdateFrequency { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SpectatorClass

Class used by spectators, assigned by GameModeBase.

Declaration
public SubclassOf<SpectatorPawn> SpectatorClass { get; }
Property Value
Type Description
SubclassOf<SpectatorPawn>
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

GetPlayerRespawnDelay(Controller)

Returns how much time needs to be spent before a player can respawn

Declaration
public float GetPlayerRespawnDelay(Controller Controller)
Parameters
Type Name Description
Controller Controller
Returns
Type Description
System.Single
| Improve this Doc View Source

GetPlayerStartTime(Controller)

Returns the time that should be used as when a player started

Declaration
public float GetPlayerStartTime(Controller Controller)
Parameters
Type Name Description
Controller Controller
Returns
Type Description
System.Single
| Improve this Doc View Source

GetServerWorldTimeSeconds()

Returns the simulated TimeSeconds on the server, will be synchronized on client and server

Declaration
public float GetServerWorldTimeSeconds()
Returns
Type Description
System.Single
| Improve this Doc View Source

HasBegunPlay()

Returns true if the world has started play (called BeginPlay on actors)

Declaration
public bool HasBegunPlay()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

HasMatchStarted()

Returns true if the world has started match (called MatchStarted callbacks)

Declaration
public bool HasMatchStarted()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static GameStateBase New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
GameStateBase

Operators

| Improve this Doc View Source

Implicit(IntPtr to GameStateBase)

Convert from IntPtr to UObject

Declaration
public static implicit operator GameStateBase(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
GameStateBase