Inheritance diagram for SCR_EditorManagerCore:

[legend]

Public Member Functions
int	GetEditorEntities (out notnull array< SCR_EditorManagerEntity > outEditorEntities)
	Get the list of all editor entities.

bool	SetEditorManager (SCR_EditorManagerEntity entity)
	Set the local instance of the editor manager.

SCR_EditorManagerEntity	GetEditorManager ()
	Get local instance of the editor manager.

SCR_EditorManagerEntity	GetEditorManager (int playerID)
	Get editor manager of given player.

SCR_EditorServerEntity	GetEditorServer ()
	Get editor server entity.

void	SetSettingsEntity (SCR_EditorSettingsEntity entity)
	Assign entity with world-specific editor settings.

SCR_EditorSettingsEntity	GetSettingsEntity ()
	Get world-specific editor settings entity.

SCR_EditorModePrefab	GetBaseModePrefab (EEditorMode modeType)
	Get base mode prefab.

EEditorMode	GetBaseModes (EEditorModeFlag flags=-1, bool coreOnly=false)
	Get all base mode types.

int	GetBaseModePrefabs (out notnull array< SCR_EditorModePrefab > outPrefabs, EEditorModeFlag flags=-1, bool coreOnly=false)
	Get prefabs of all base mode types.

int	GetBaseModePrefabs (out notnull SCR_SortedArray< SCR_EditorModePrefab > outPrefabs, EEditorModeFlag flags=-1, bool coreOnly=false)
	Get sorted prefabs of all base mode types.

SCR_EditorModeUIInfo	GetDefaultModeInfo (EEditorMode modeType)
	Get UI info of given default mode.

void	OnPlayFromCameraPos ()

override void	OnGameStart ()

override void	OnGameEnd ()

void	SCR_EditorManagerCore ()

void	~SCR_EditorManagerCore ()

Public Attributes
ref ScriptInvoker	Event_OnEditorManagerCreatedServer = new ScriptInvoker
	Called when an editor manager is created after a player connects.

ref ScriptInvoker	Event_OnEditorManagerDeletedServer = new ScriptInvoker
	Called when an editor manager is deleted after a player disconnects.

ref ScriptInvoker	Event_OnEditorManagerInitOwner = new ScriptInvoker
	Called when an editor manager is initialized on owner's machine.

ref ScriptInvoker	Event_OnEditorManagerPing = new ScriptInvoker
	Called when user sends a ping.

Protected Member Functions
SCR_EditorManagerEntity	CreateEditorManager (int playerID)

void	DeleteEditorManager (int playerID)

void	OnPlayerRegistered (int playerID)

void	OnPlayerDisconnected (int playerID)

void	OnPlayerSpawn (int playerID, IEntity controlledEntity)

void	OnPlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)

void	OnPlayerDeleted (int playerID, IEntity player)

void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)

void	OnReconnectOnPreviousCharacter (notnull SCR_ReconnectData reconnectData)

Protected Attributes
int	m_iRestoreOnReconnectTimeout

Detailed Description

Core component to manage SCR_EditorManagerEntity.

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

Constructor & Destructor Documentation

◆ SCR_EditorManagerCore()

void SCR_EditorManagerCore.SCR_EditorManagerCore ( )

◆ ~SCR_EditorManagerCore()

void SCR_EditorManagerCore.~SCR_EditorManagerCore ( )

Member Function Documentation

◆ CreateEditorManager()

SCR_EditorManagerEntity SCR_EditorManagerCore.CreateEditorManager ( int playerID )

protected

◆ DeleteEditorManager()

void SCR_EditorManagerCore.DeleteEditorManager ( int playerID )

protected

◆ GetBaseModePrefab()

SCR_EditorModePrefab SCR_EditorManagerCore.GetBaseModePrefab ( EEditorMode modeType )

Get base mode prefab.

Parameters

modeType Mode type

Returns: SCR_EditorModePrefab

◆ GetBaseModePrefabs() [1/2]

int SCR_EditorManagerCore.GetBaseModePrefabs	(	out notnull array< SCR_EditorModePrefab >	outPrefabs,
		EEditorModeFlag	flags = `-1`,
		bool	coreOnly = `false`
	)

Get prefabs of all base mode types.

Parameters

flags	Flags filter
coreOnly	When true, base mode prefab override on SCR_EditorSettingsEntity will be ignored

Returns: Prefabs of base mode types

◆ GetBaseModePrefabs() [2/2]

int SCR_EditorManagerCore.GetBaseModePrefabs	(	out notnull SCR_SortedArray< SCR_EditorModePrefab >	outPrefabs,
		EEditorModeFlag	flags = `-1`,
		bool	coreOnly = `false`
	)

Get sorted prefabs of all base mode types.

Parameters

flags	Flags filter
coreOnly	When true, base mode prefab override on SCR_EditorSettingsEntity will be ignored

Returns: Sorted prefabs of base mode types

◆ GetBaseModes()

EEditorMode SCR_EditorManagerCore.GetBaseModes	(	EEditorModeFlag	flags = `-1`,
		bool	coreOnly = `false`
	)

Get all base mode types.

Parameters

flags	Flags filter
coreOnly	When true, base mode prefab override on SCR_EditorSettingsEntity will be ignored

Returns: Values of base mode types

◆ GetDefaultModeInfo()

SCR_EditorModeUIInfo SCR_EditorManagerCore.GetDefaultModeInfo ( EEditorMode modeType )

Get UI info of given default mode.

Parameters

modeType Mode type

Returns: UI info

◆ GetEditorEntities()

int SCR_EditorManagerCore.GetEditorEntities ( out notnull array< SCR_EditorManagerEntity > outEditorEntities )

Get the list of all editor entities.

Parameters

[out] outEditorEntities Array of editor entities

◆ GetEditorManager() [1/2]

SCR_EditorManagerEntity SCR_EditorManagerCore.GetEditorManager ( )

Get local instance of the editor manager.

Returns: Editor manager

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

◆ GetEditorManager() [2/2]

SCR_EditorManagerEntity SCR_EditorManagerCore.GetEditorManager ( int playerID )

Get editor manager of given player.

Parameters

playerID Player ID

Returns: Editor manager

◆ GetEditorServer()

SCR_EditorServerEntity SCR_EditorManagerCore.GetEditorServer ( )

Get editor server entity.

Returns: Editor server entity

◆ GetSettingsEntity()

SCR_EditorSettingsEntity SCR_EditorManagerCore.GetSettingsEntity ( )

Get world-specific editor settings entity.

Returns: Settings entity

◆ OnGameEnd()

override void SCR_EditorManagerCore.OnGameEnd ( )

◆ OnGameStart()

override void SCR_EditorManagerCore.OnGameStart ( )

◆ OnPlayerDeleted()

void SCR_EditorManagerCore.OnPlayerDeleted	(	int	playerID,
		IEntity	player
	)

protected

◆ OnPlayerDisconnected()

void SCR_EditorManagerCore.OnPlayerDisconnected ( int playerID )

protected

◆ OnPlayerKilled()

void SCR_EditorManagerCore.OnPlayerKilled	(	int	playerId,
		IEntity	playerEntity,
		IEntity	killerEntity,
		notnull Instigator	killer
	)

protected

◆ OnPlayerRegistered()

void SCR_EditorManagerCore.OnPlayerRegistered ( int playerID )

protected

◆ OnPlayerRoleChange()

void SCR_EditorManagerCore.OnPlayerRoleChange	(	int	playerId,
		EPlayerRole	roleFlags
	)

protected

◆ OnPlayerSpawn()

void SCR_EditorManagerCore.OnPlayerSpawn	(	int	playerID,
		IEntity	controlledEntity
	)

protected

◆ OnPlayFromCameraPos()

void SCR_EditorManagerCore.OnPlayFromCameraPos ( )

◆ OnReconnectOnPreviousCharacter()

void SCR_EditorManagerCore.OnReconnectOnPreviousCharacter ( notnull SCR_ReconnectData reconnectData )

protected

◆ SetEditorManager()

bool SCR_EditorManagerCore.SetEditorManager ( SCR_EditorManagerEntity entity )

Set the local instance of the editor manager.

Shows an error when it already exists.

Parameters

entity Editor manager

◆ SetSettingsEntity()

void SCR_EditorManagerCore.SetSettingsEntity ( SCR_EditorSettingsEntity entity )

Assign entity with world-specific editor settings.

Will not do anything if settings are already assigned.

Parameters

entity Settings entity

Member Data Documentation

◆ Event_OnEditorManagerCreatedServer

ref ScriptInvoker SCR_EditorManagerCore.Event_OnEditorManagerCreatedServer = new ScriptInvoker

Called when an editor manager is created after a player connects.

Parameters

editorManager Created editor manager

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

◆ Event_OnEditorManagerDeletedServer

ref ScriptInvoker SCR_EditorManagerCore.Event_OnEditorManagerDeletedServer = new ScriptInvoker

Called when an editor manager is deleted after a player disconnects.

Parameters

editorManager Deleted editor manager

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

◆ Event_OnEditorManagerInitOwner

ref ScriptInvoker SCR_EditorManagerCore.Event_OnEditorManagerInitOwner = new ScriptInvoker

Called when an editor manager is initialized on owner's machine.

Parameters

editorManager Created editor manager

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

◆ Event_OnEditorManagerPing

ref ScriptInvoker SCR_EditorManagerCore.Event_OnEditorManagerPing = new ScriptInvoker

Called when user sends a ping.

Parameters

playerID ID of player who sent the ping

◆ m_iRestoreOnReconnectTimeout

int SCR_EditorManagerCore.m_iRestoreOnReconnectTimeout

protected

The documentation for this interface was generated from the following file:

Game/Editor/Core/SCR_EditorManagerCore.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_EditorManagerCore()

◆ ~SCR_EditorManagerCore()

Member Function Documentation

◆ CreateEditorManager()

◆ DeleteEditorManager()

◆ GetBaseModePrefab()

◆ GetBaseModePrefabs() [1/2]

◆ GetBaseModePrefabs() [2/2]

◆ GetBaseModes()

◆ GetDefaultModeInfo()

◆ GetEditorEntities()

◆ GetEditorManager() [1/2]

◆ GetEditorManager() [2/2]

◆ GetEditorServer()

◆ GetSettingsEntity()

◆ OnGameEnd()

◆ OnGameStart()

◆ OnPlayerDeleted()

◆ OnPlayerDisconnected()

◆ OnPlayerKilled()

◆ OnPlayerRegistered()

◆ OnPlayerRoleChange()

◆ OnPlayerSpawn()

◆ OnPlayFromCameraPos()

◆ OnReconnectOnPreviousCharacter()

◆ SetEditorManager()

◆ SetSettingsEntity()

Member Data Documentation

◆ Event_OnEditorManagerCreatedServer

◆ Event_OnEditorManagerDeletedServer

◆ Event_OnEditorManagerInitOwner

◆ Event_OnEditorManagerPing

◆ m_iRestoreOnReconnectTimeout