SCR_ScenarioFrameworkSlotMarker.c File Reference

Go to the source code of this file.

Classes
class	SCR_ScenarioFrameworkSlotMarkerClass
class	SCR_ScenarioFrameworkMarkerType

Functions
SCR_ScenarioFrameworkSlotMarkerClass SCR_ScenarioFrameworkSlotBaseClass	Attribute (desc:"Marker Type", category:"Map Marker")
void	SetMapMarkerType (SCR_ScenarioFrameworkMarkerType type)
SCR_MapMarkerBase	GetMapMarker ()
override void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false, bool affectRandomization=true, bool deleteSpawnedEntities=true)
void	CreateMapMarker ()
	Creates a map marker based on provided type, sets its position, custom text, and adds it to map marker manager if possible.
void	RemoveMapMarker ()
	Removes map marker by ID from map marker manager.
override void	SetIsTerminated (bool state)
void	~SCR_ScenarioFrameworkSlotMarker ()
	Removes map marker when not in edit mode, despawns object if in edit mode.
SCR_ScenarioFrameworkMarkerType ScriptAndConfig	BaseContainerProps ()

Variables
LocalizedString	m_sMapMarkerText

Function Documentation

AfterAllChildrenSpawned()

override void AfterAllChildrenSpawned

(

SCR_ScenarioFrameworkLayerBase

layer

)

Spawns map marker after all children spawned in scenario layer.

Parameters

[in]

layer

for which this is called.

Definition at line 41 of file SCR_ScenarioFrameworkSlotMarker.c.

Attribute()

SCR_ScenarioFrameworkSlotMarkerClass SCR_ScenarioFrameworkSlotBaseClass Attribute	(	desc:"Marker Type"	,
		category:"Map Marker"	)

Returns

Represents the type of map marker in the scenario.

Definition at line 1 of file SCR_ScenarioFrameworkSlotMarker.c.

BaseContainerProps()

SCR_ScenarioFrameworkMarkerType ScriptAndConfig BaseContainerProps ( )

protected

CreateMapMarker()

void CreateMapMarker ( )

protected

Creates a map marker based on provided type, sets its position, custom text, and adds it to map marker manager if possible.

Definition at line 62 of file SCR_ScenarioFrameworkSlotMarker.c.

GetMapMarker()

SCR_MapMarkerBase GetMapMarker

(

)

Returns

Represents the map marker object used by the method.

Definition at line 33 of file SCR_ScenarioFrameworkSlotMarker.c.

RemoveMapMarker()

void RemoveMapMarker ( )

protected

Removes map marker by ID from map marker manager.

Definition at line 126 of file SCR_ScenarioFrameworkSlotMarker.c.

RestoreToDefault()

override void RestoreToDefault	(	bool	includeChildren = false,
		bool	reinitAfterRestoration = false,
		bool	affectRandomization = true,
		bool	deleteSpawnedEntities = true )

Restores default state, removes map marker, nullifies it, calls base method.

Parameters

[in]	includeChildren	Includes children objects in default restoration process.
[in]	reinitAfterRestoration	Resets object after restoration, optionally reinitializing it.
[in]	affectRandomization	Affects randomization during default restoration.

Definition at line 54 of file SCR_ScenarioFrameworkSlotMarker.c.

SetIsTerminated()

override void SetIsTerminated ( bool state )

protected

Definition at line 147 of file SCR_ScenarioFrameworkSlotMarker.c.

SetMapMarkerType()

void SetMapMarkerType

(

SCR_ScenarioFrameworkMarkerType

type

)

Parameters

[in]

type

Sets map marker type for scenario framework marker.

Definition at line 26 of file SCR_ScenarioFrameworkSlotMarker.c.

~SCR_ScenarioFrameworkSlotMarker()

void ~SCR_ScenarioFrameworkSlotMarker ( )

protected

Removes map marker when not in edit mode, despawns object if in edit mode.

Definition at line 156 of file SCR_ScenarioFrameworkSlotMarker.c.

Variable Documentation

m_sMapMarkerText

LocalizedString m_sMapMarkerText

Definition at line 1 of file SCR_ScenarioFrameworkSlotMarker.c.