Manager of player delegate - entity representing the player (works even when controlled entity doesn't exist, e.g., when player is waiting for respawn) More...

Inheritance diagram for SCR_PlayerDelegateEditorComponent:

Public Member Functions
void	RegisterDelegate (SCR_EditablePlayerDelegateComponent delegate)
	Register delegate locally

void	UnegisterDelegate (SCR_EditablePlayerDelegateComponent delegate)
	Unregister delegate locally

int	GetDelegates (out notnull map< int, SCR_EditablePlayerDelegateComponent > outDelegates)
	Get all player delegates.

SCR_EditablePlayerDelegateComponent	GetDelegate (int playerID)
	Get delegate of player with given ID.

bool	HasPlayerWithUnlimitedEditor ()

ScriptInvoker	GetOnLimitedEditorChanged ()
	Get script invoker called when editor belonging to any player become limited (e.g., only photo mode, without any editing capabilities), or vice versa.

override void	EOnEditorInitServer ()
	When the entity is created (called on server)

override void	EOnEditorDeleteServer ()
	When the entity is destroyed (called on server)

Public Member Functions inherited from SCR_BaseEditorComponent
void	OnInitBase ()

void	OnDeleteBase ()

void	OnRequestBase (bool isOpen)

void	OnOpenedBase ()

void	OnClosedBase ()

void	OnPreActivateBase ()

void	OnActivateBase ()

bool	OnActivateAsyncBase (int attempt)

void	OnPostActivateBase ()

void	OnDeactivateBase ()

void	OnPostDeactivateBase ()

bool	OnDeactivateAsyncBase (int attempt)

void	OnEffectBase (SCR_BaseEditorEffect effect)

SCR_EditorManagerEntity	GetManager ()
	Get editor manager this component belongs to.

SCR_BaseEditorComponent	FindEditorComponent (TypeName type, bool showError=false, bool modeFirst=false)
	Get the editor manager to which this component belongs.

EntityComponentPrefabData	GetEditorComponentData ()
	Get prefab data of this component.

bool	IsRemoved ()
	Check if the component is being deleted.

void	ResetEditorComponent ()
	Reset values controlled by the component.

ScriptInvoker	GetOnEffect ()
	Get event called when an effect is activated.

void	InitServer ()

void	InitOwner ()

override void	OnPostInit (IEntity owner)

void	SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_BaseEditorComponent ()

Protected Member Functions
void	OnLimitedEditorChanged (int playerID, bool isLimited)

void	OnSpawnServer (int playerID, IEntity controlledEntity)

void	OnDeathServer (notnull SCR_InstigatorContextData instigatorContextData)

void	OnPlayerDeletedServer (int playerID, IEntity controlledEntity)

Protected Member Functions inherited from SCR_BaseEditorComponent
bool	IsOnEditorManager ()

bool	IsOwner ()

bool	IsProxy ()

bool	IsMaster ()

bool	IsAdmin ()

SCR_BaseEditorComponent	GetParentComponent ()

void	SetParentComponent (SCR_BaseEditorComponent parent)

void	SendNotification (ENotification notificationID, int selfID=0, int targetID=0, vector position=vector.Zero)

void	EOnEditorInit ()
	When the entity is created.

void	EOnEditorDelete ()
	When the entity is destroyed.

void	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.

void	EOnEditorOpen ()
	When the editor is opened.

void	EOnEditorClose ()
	When the editor is closed.

void	EOnEditorPreActivate ()
	Before the component is activated.

void	EOnEditorActivate ()
	When the component is activated.

bool	EOnEditorActivateAsync (int attempt)
	When the component is activated.

void	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.

void	EOnEditorDeactivate ()
	When the component is deactivated.

bool	EOnEditorDeactivateAsync (int attempt)
	When the component is deactivated.

void	EOnEditorPostDeactivate ()
	When the component is deactivated, but after the next mode is activated.

void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.

void	EOnEffect (SCR_BaseEditorEffect effect)
	When an effect is created in reaction an an event.

void	EOnEditorOpenServer ()
	When the editor is opened (called on server)

void	EOnEditorOpenServerCallback ()
	When the editor is opened (called on server after async loading finished on client)

void	EOnEditorCloseServer ()
	When the editor is closed (called on server)

void	EOnEditorCloseServerCallback ()
	When the editor is closed (called on server after async loading finished on client)

void	EOnEditorActivateServer ()
	When the component is activated (called on server)

void	EOnEditorDeactivateServer ()
	When the component is deactivated (called on server)

Protected Attributes
ResourceName	m_PlayerDelegatePrefab

int	m_iPlayerID

SCR_EditablePlayerDelegateComponent	m_PlayerDelegate

ref map< int, SCR_EditablePlayerDelegateComponent >	m_Delegates = new map<int, SCR_EditablePlayerDelegateComponent>

ref ScriptInvoker	m_OnLimitedEditorChanged = new ScriptInvoker

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseEditorComponent
static Managed	GetInstance (TypeName type, bool showError=false, bool modeFirst=false)
	Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity).

static Managed	GetInstance (SCR_EditorBaseEntity editorManager, TypeName type, bool showError=false)
	Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity).

static int	GetAllInstances (TypeName type, out notnull array< Managed > outComponents)
	Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity).

Detailed Description

Manager of player delegate - entity representing the player (works even when controlled entity doesn't exist, e.g., when player is waiting for respawn)

Member Function Documentation

◆ EOnEditorDeleteServer()

override void SCR_PlayerDelegateEditorComponent.EOnEditorDeleteServer ( )

When the entity is destroyed (called on server)

Implements SCR_BaseEditorComponent.

◆ EOnEditorInitServer()

override void SCR_PlayerDelegateEditorComponent.EOnEditorInitServer ( )

When the entity is created (called on server)

Implements SCR_BaseEditorComponent.

◆ GetDelegate()

SCR_EditablePlayerDelegateComponent SCR_PlayerDelegateEditorComponent.GetDelegate ( int playerID )

Get delegate of player with given ID.

Parameters

playerID Player ID

Returns: Delegate entity

◆ GetDelegates()

int SCR_PlayerDelegateEditorComponent.GetDelegates ( out notnull map< int, SCR_EditablePlayerDelegateComponent > outDelegates )

Get all player delegates.

Parameters

outDelegates Map in format <player ID, delegate entity> filled by the function

Returns: Number of delegates

◆ GetOnLimitedEditorChanged()

ScriptInvoker SCR_PlayerDelegateEditorComponent.GetOnLimitedEditorChanged ( )

Get script invoker called when editor belonging to any player become limited (e.g., only photo mode, without any editing capabilities), or vice versa.

Returns: ScriptInvoker

◆ HasPlayerWithUnlimitedEditor()

bool SCR_PlayerDelegateEditorComponent.HasPlayerWithUnlimitedEditor ( )

Returns: True if the current session has at least one player with unlimited editor.

◆ OnDeathServer()

void SCR_PlayerDelegateEditorComponent.OnDeathServer ( notnull SCR_InstigatorContextData instigatorContextData )

protected

◆ OnLimitedEditorChanged()

void SCR_PlayerDelegateEditorComponent.OnLimitedEditorChanged	(	int	playerID,
		bool	isLimited )

protected

◆ OnPlayerDeletedServer()

void SCR_PlayerDelegateEditorComponent.OnPlayerDeletedServer	(	int	playerID,
		IEntity	controlledEntity )

protected

◆ OnSpawnServer()

void SCR_PlayerDelegateEditorComponent.OnSpawnServer	(	int	playerID,
		IEntity	controlledEntity )

protected

◆ RegisterDelegate()

void SCR_PlayerDelegateEditorComponent.RegisterDelegate ( SCR_EditablePlayerDelegateComponent delegate )

Register delegate locally

Parameters

delegate Player delegate

◆ UnegisterDelegate()

void SCR_PlayerDelegateEditorComponent.UnegisterDelegate ( SCR_EditablePlayerDelegateComponent delegate )

Unregister delegate locally

Parameters

delegate Player delegate

Member Data Documentation

◆ m_Delegates

ref map<int, SCR_EditablePlayerDelegateComponent> SCR_PlayerDelegateEditorComponent.m_Delegates = new map<int, SCR_EditablePlayerDelegateComponent>

protected

◆ m_iPlayerID

int SCR_PlayerDelegateEditorComponent.m_iPlayerID

protected

◆ m_OnLimitedEditorChanged

ref ScriptInvoker SCR_PlayerDelegateEditorComponent.m_OnLimitedEditorChanged = new ScriptInvoker

protected

◆ m_PlayerDelegate

SCR_EditablePlayerDelegateComponent SCR_PlayerDelegateEditorComponent.m_PlayerDelegate

protected

◆ m_PlayerDelegatePrefab

ResourceName SCR_PlayerDelegateEditorComponent.m_PlayerDelegatePrefab

protected

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

Game/Editor/Components/Editor/SCR_PlayerDelegateEditorComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ EOnEditorDeleteServer()

◆ EOnEditorInitServer()

◆ GetDelegate()

◆ GetDelegates()

◆ GetOnLimitedEditorChanged()

◆ HasPlayerWithUnlimitedEditor()

◆ OnDeathServer()

◆ OnLimitedEditorChanged()

◆ OnPlayerDeletedServer()

◆ OnSpawnServer()

◆ RegisterDelegate()

◆ UnegisterDelegate()

Member Data Documentation

◆ m_Delegates

◆ m_iPlayerID

◆ m_OnLimitedEditorChanged

◆ m_PlayerDelegate

◆ m_PlayerDelegatePrefab