Class GameMode

GameMode is a subclass of GameModeBase that behaves like a multiplayer match-based game.

Inheritance
System.Object
UObject
Actor
Info
GameModeBase
GameMode
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 GameMode : GameModeBase
Remarks

It has default behavior for picking spawn points and match state. If you want a simpler base, inherit from GameModeBase instead.

Properties

| Improve this Doc View Source

bDelayedStart

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

bHandleDedicatedServerReplays

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

DefaultObject

Get UE4 Default Object for this Class

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

EngineMessageClass

Contains strings describing localized game agnostic messages.

Declaration
public SubclassOf<LocalMessage> EngineMessageClass { get; set; }
Property Value
Type Description
SubclassOf<LocalMessage>
| Improve this Doc View Source

InactivePlayerArray

PlayerStates of players who have disconnected from the server (saved in case they reconnect)

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

InactivePlayerStateLifeSpan

Time a playerstate will stick around in an inactive state after a player logout

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

MatchState

What match state we are currently in

Declaration
public Name MatchState { get; set; }
Property Value
Type Description
Name
| Improve this Doc View Source

MaxInactivePlayers

The maximum number of inactive players before we kick the oldest ones out

Declaration
public int MaxInactivePlayers { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

MinRespawnDelay

Minimum time before player can respawn after dying.

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

NumBots

number of non-human players (AI controlled but participating as a player).

Declaration
public int NumBots { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

NumPlayers

Current number of human players.

Declaration
public int NumPlayers { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

NumSpectators

Current number of spectators.

Declaration
public int NumSpectators { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

NumTravellingPlayers

Number of players that are still traveling from a previous map

Declaration
public int NumTravellingPlayers { get; }
Property Value
Type Description
System.Int32
| 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

AbortMatch()

Report that a match has failed due to unrecoverable error

Declaration
public void AbortMatch()
| Improve this Doc View Source

EndMatch()

Transition from InProgress to WaitingPostMatch. You can call this manually, will also get called if ReadyToEndMatch returns true

Declaration
public void EndMatch()
| Improve this Doc View Source

GetMatchState()

Returns the current match state, this is an accessor to protect the state machine flow

Declaration
public Name GetMatchState()
Returns
Type Description
Name
| Improve this Doc View Source

HasMatchEnded()

Returns true if the match state is WaitingPostMatch or later

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

IsMatchInProgress()

Returns true if the match state is InProgress or other gameplay state

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

New(UObject, Name)

Spawn an object of this class

Declaration
public static GameMode New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
GameMode
| Improve this Doc View Source

RestartGame()

Restart the game, by default travel to the current map

Declaration
public void RestartGame()
| Improve this Doc View Source

Say(String)

Exec command to broadcast a string to all players

Declaration
public void Say(string Msg)
Parameters
Type Name Description
System.String Msg
| Improve this Doc View Source

StartMatch()

Transition from WaitingToStart to InProgress. You can call this manually, will also get called if ReadyToStartMatch returns true

Declaration
public void StartMatch()

Events

| Improve this Doc View Source

K2_OnSetMatchState

Implementable event to respond to match state changes

Declaration
public event GameMode.K2_OnSetMatchState_delegate K2_OnSetMatchState
Event Type
Type Description
GameMode.K2_OnSetMatchState_delegate
| Improve this Doc View Source

ReadyToEndMatch

@return true if ready to End Match. Games should override this

Declaration
public event GameMode.ReadyToEndMatch_delegate ReadyToEndMatch
Event Type
Type Description
GameMode.ReadyToEndMatch_delegate
| Improve this Doc View Source

ReadyToStartMatch

@return True if ready to Start Match. Games should override this

Declaration
public event GameMode.ReadyToStartMatch_delegate ReadyToStartMatch
Event Type
Type Description
GameMode.ReadyToStartMatch_delegate

Operators

| Improve this Doc View Source

Implicit(IntPtr to GameMode)

Convert from IntPtr to UObject

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