SCR_MapExporterPlugin Interface Reference

Inheritance diagram for SCR_MapExporterPlugin:

Public Member Functions
override void	Run ()
void	PerformExport ()
void	OnBeforeResourceExport ()
override void	Configure ()
SCR_MapExporterConfig	GetConfig (ResourceName configPath)
bool	AddAssetToMigrate (ExporterAssetType type, ResourceName resource, ResourceName resSource=string.Empty)
void	HandleSpecificEntityDependencies (notnull BaseContainer entitySource)
void	HandleSpecificEntityData (notnull BaseContainer entitySource)
void	PurgeCurveData (IEntitySource curve)
bool	IsEntityClassBlacklisted (IEntitySource entSource)
string	GetAlternateClassName (string currentName)
bool	IsComponentClassBlacklisted (string className)
bool	IsAnyComponentIncompatible (notnull IEntitySource entSource)
bool	DoesEntityNeedReplacing (IEntitySource entSource)
bool	DoesPrefabNeedReplacingFast (BaseContainer prefab)
bool	DoesPrefabNeedReplacing (BaseContainer prefab)
void	RegisterXob (BaseContainer meshObjectComp)
void	RegisterPrefabXob (IEntitySource entSource)
void	DiscoverMeshObjectMaterialOverrides (BaseContainer meshContainer, ResourceName resourceName)
void	GetMaterialsFromXobs ()
void	GetTexturesFromMaterials ()
void	RegisterMaterial (ResourceName resName)
void	RunPrefabDiscovery (IEntitySource prefab)
void	ProcessEntityRecur (IEntitySource entSource, IEntitySource parent, bool parentToBeDeleted)
IEntitySource	CloneEntityFull (IEntitySource entSource, IEntitySource parent)
bool	IsFromPrefabLibrary (ResourceName prefab)
IEntitySource	DeepPrefabEntityCloneRecur (IEntitySource prefab, IEntitySource parent, ResourceName ancestor)
void	RegisterNewPrefab (ResourceName resNameOriginal, ResourceName resNameNew)
bool	IsPartOfPrefab (IEntitySource entSource)
void	CopyComponentProperties (BaseContainer sourceComponent, BaseContainer targetComponent, BaseContainer targetEntity, array< ref ContainerIdPathEntry > path)
void	CopyComponents (IEntitySource source, IEntitySource target)
void	CopyComponent (string componentName, IEntitySource source, IEntitySource target)
void	CopyComponentPropertiesSpecial (string componentName, BaseContainer sourceComponent, BaseContainer targetComponent, BaseContainer targetEntity, array< ref ContainerIdPathEntry > path)
void	ExportFiles (set< ResourceName > resourceNames)
void	ExportFile (string filePath)
void	ExportMapData ()
void	ExportSharedData ()
IEntitySource	CloneSingleEntity (string className, IEntitySource oldEntSrc, IEntitySource parent, int layerID=0)
void	CopyEntityProperties (IEntitySource oldEntSrc, IEntitySource newEntSrc)
void	CopyContainerProperties (IEntitySource oldEntSrc, IEntitySource newEntSrc)
void	CopyEntityPropertiesSpecial (IEntitySource oldEntSrc, IEntitySource newEntSrc)
void	FixWeatherConfig (string varName, IEntitySource oldEntSrc, IEntitySource newEntSrc)
void	ProcessDiscoveredPrefabs ()
void	PerformResourceExport (WBProgressDialog dialog)
void	ClearExportSourceData ()
void	DeleteFilePlus (string path)
bool	IsExportTargetFolderEmpty ()
Public Member Functions inherited from WorkbenchPlugin
void	Run ()
void	RunCommandline ()
void	Configure ()
void	OnResourceContextMenu (notnull array< ResourceName > resources)
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Static Public Member Functions
static BaseContainer	GetPrefab (BaseContainer source)
static ResourceName	GetPrefabName (BaseContainer source)
static IEntityComponentSource	FindComponentSource (IEntitySource prefabEntity, string componentClassName)

Public Attributes
ResourceName	m_ConfigResource
string	m_ExportDestination
bool	m_AllowResourceCopy
ref SCR_MapExporterConfig	m_Config
WorldEditor	m_WorldEditor
ref map< string, string >	m_mEntityClassBlacklist
ref map< ResourceName, ResourceName >	m_mCreatedPrefabs
ref TStringArray	m_aCreatedFiles
ref set< BaseContainer >	m_sDiscoveredPrefabs
ref map< ResourceName, bool >	m_mPrefabsNeedingReplace
ref set< ResourceName >	m_sPrefabsToMigrate
ref set< ResourceName >	m_sModelsToMigrate
ref set< ResourceName >	m_sMaterialsToMigrate
ref set< ResourceName >	m_sTexturesToMigrate
ref set< ResourceName >	m_sMiscToMigrate
ref set< ResourceName >	m_sResourceExcludeGUIDs
WorldEditorAPI	m_WEapi
ResourceManager	resourceManager
bool	m_PerformExport
string	m_sConvertedAssetsSuffix
bool	m_bUsingAssetSuffixFallback

Static Public Attributes
const string	SUFFIX_FALLBACK = "__DefExport"

Protected Member Functions
bool	ButtonExport ()
bool	Init ()
void	InitVars ()
ResourceName	ClonePrefabFast (BaseContainer prefab)
ResourceName	ClonePrefabSlow (notnull BaseContainer originalPrefab)

Member Function Documentation

AddAssetToMigrate()

bool SCR_MapExporterPlugin.AddAssetToMigrate	(	ExporterAssetType	type,
		ResourceName	resource,
		ResourceName	resSource = string::Empty
	)

ButtonExport()

bool SCR_MapExporterPlugin.ButtonExport ( )

protected

ClearExportSourceData()

void SCR_MapExporterPlugin.ClearExportSourceData

(

)

CloneEntityFull()

IEntitySource SCR_MapExporterPlugin.CloneEntityFull	(	IEntitySource	entSource,
		IEntitySource	parent
	)

ClonePrefabFast()

ResourceName SCR_MapExporterPlugin.ClonePrefabFast ( BaseContainer  prefab )

protected

ClonePrefabSlow()

ResourceName SCR_MapExporterPlugin.ClonePrefabSlow ( notnull BaseContainer  originalPrefab )

protected

CloneSingleEntity()

IEntitySource SCR_MapExporterPlugin.CloneSingleEntity	(	string	className,
		IEntitySource	oldEntSrc,
		IEntitySource	parent,
		int	layerID = 0
	)

Configure()

override void SCR_MapExporterPlugin.Configure

(

)

Implements WorkbenchPlugin.

CopyComponent()

void SCR_MapExporterPlugin.CopyComponent	(	string	componentName,
		IEntitySource	source,
		IEntitySource	target
	)

CopyComponentProperties()

void SCR_MapExporterPlugin.CopyComponentProperties	(	BaseContainer	sourceComponent,
		BaseContainer	targetComponent,
		BaseContainer	targetEntity,
		array< ref ContainerIdPathEntry >	path
	)

CopyComponentPropertiesSpecial()

void SCR_MapExporterPlugin.CopyComponentPropertiesSpecial	(	string	componentName,
		BaseContainer	sourceComponent,
		BaseContainer	targetComponent,
		BaseContainer	targetEntity,
		array< ref ContainerIdPathEntry >	path
	)

CopyComponents()

void SCR_MapExporterPlugin.CopyComponents	(	IEntitySource	source,
		IEntitySource	target
	)

CopyContainerProperties()

void SCR_MapExporterPlugin.CopyContainerProperties	(	IEntitySource	oldEntSrc,
		IEntitySource	newEntSrc
	)

CopyEntityProperties()

void SCR_MapExporterPlugin.CopyEntityProperties	(	IEntitySource	oldEntSrc,
		IEntitySource	newEntSrc
	)

CopyEntityPropertiesSpecial()

void SCR_MapExporterPlugin.CopyEntityPropertiesSpecial	(	IEntitySource	oldEntSrc,
		IEntitySource	newEntSrc
	)

DeepPrefabEntityCloneRecur()

IEntitySource SCR_MapExporterPlugin.DeepPrefabEntityCloneRecur	(	IEntitySource	prefab,
		IEntitySource	parent,
		ResourceName	ancestor
	)

DeleteFilePlus()

void SCR_MapExporterPlugin.DeleteFilePlus

(

string

path

)

DiscoverMeshObjectMaterialOverrides()

void SCR_MapExporterPlugin.DiscoverMeshObjectMaterialOverrides	(	BaseContainer	meshContainer,
		ResourceName	resourceName
	)

DoesEntityNeedReplacing()

bool SCR_MapExporterPlugin.DoesEntityNeedReplacing

(

IEntitySource

entSource

)

DoesPrefabNeedReplacing()

bool SCR_MapExporterPlugin.DoesPrefabNeedReplacing

(

BaseContainer

prefab

)

DoesPrefabNeedReplacingFast()

bool SCR_MapExporterPlugin.DoesPrefabNeedReplacingFast

(

BaseContainer

prefab

)

ExportFile()

void SCR_MapExporterPlugin.ExportFile

(

string

filePath

)

ExportFiles()

void SCR_MapExporterPlugin.ExportFiles

(

set< ResourceName >

resourceNames

)

ExportMapData()

void SCR_MapExporterPlugin.ExportMapData

(

)

ExportSharedData()

void SCR_MapExporterPlugin.ExportSharedData

(

)

FindComponentSource()

static IEntityComponentSource SCR_MapExporterPlugin.FindComponentSource ( IEntitySource  prefabEntity, string  componentClassName  )

static

FixWeatherConfig()

void SCR_MapExporterPlugin.FixWeatherConfig	(	string	varName,
		IEntitySource	oldEntSrc,
		IEntitySource	newEntSrc
	)

GetAlternateClassName()

string SCR_MapExporterPlugin.GetAlternateClassName

(

string

currentName

)

GetConfig()

SCR_MapExporterConfig SCR_MapExporterPlugin.GetConfig

(

ResourceName

configPath

)

GetMaterialsFromXobs()

void SCR_MapExporterPlugin.GetMaterialsFromXobs

(

)

GetPrefab()

static BaseContainer SCR_MapExporterPlugin.GetPrefab ( BaseContainer  source )

static

GetPrefabName()

static ResourceName SCR_MapExporterPlugin.GetPrefabName ( BaseContainer  source )

static

GetTexturesFromMaterials()

void SCR_MapExporterPlugin.GetTexturesFromMaterials

(

)

HandleSpecificEntityData()

void SCR_MapExporterPlugin.HandleSpecificEntityData

(

notnull BaseContainer

entitySource

)

HandleSpecificEntityDependencies()

void SCR_MapExporterPlugin.HandleSpecificEntityDependencies

(

notnull BaseContainer

entitySource

)

Init()

bool SCR_MapExporterPlugin.Init ( )

protected

InitVars()

void SCR_MapExporterPlugin.InitVars ( )

protected

IsAnyComponentIncompatible()

bool SCR_MapExporterPlugin.IsAnyComponentIncompatible

(

notnull IEntitySource

entSource

)

IsComponentClassBlacklisted()

bool SCR_MapExporterPlugin.IsComponentClassBlacklisted

(

string

className

)

IsEntityClassBlacklisted()

bool SCR_MapExporterPlugin.IsEntityClassBlacklisted

(

IEntitySource

entSource

)

IsExportTargetFolderEmpty()

bool SCR_MapExporterPlugin.IsExportTargetFolderEmpty

(

)

IsFromPrefabLibrary()

bool SCR_MapExporterPlugin.IsFromPrefabLibrary

(

ResourceName

prefab

)

IsPartOfPrefab()

bool SCR_MapExporterPlugin.IsPartOfPrefab

(

IEntitySource

entSource

)

OnBeforeResourceExport()

void SCR_MapExporterPlugin.OnBeforeResourceExport

(

)

PerformExport()

void SCR_MapExporterPlugin.PerformExport

(

)

PerformResourceExport()

void SCR_MapExporterPlugin.PerformResourceExport

(

WBProgressDialog

dialog

)

ProcessDiscoveredPrefabs()

void SCR_MapExporterPlugin.ProcessDiscoveredPrefabs

(

)

ProcessEntityRecur()

void SCR_MapExporterPlugin.ProcessEntityRecur	(	IEntitySource	entSource,
		IEntitySource	parent,
		bool	parentToBeDeleted
	)

PurgeCurveData()

void SCR_MapExporterPlugin.PurgeCurveData

(

IEntitySource

curve

)

RegisterMaterial()

void SCR_MapExporterPlugin.RegisterMaterial

(

ResourceName

resName

)

RegisterNewPrefab()

void SCR_MapExporterPlugin.RegisterNewPrefab	(	ResourceName	resNameOriginal,
		ResourceName	resNameNew
	)

RegisterPrefabXob()

void SCR_MapExporterPlugin.RegisterPrefabXob

(

IEntitySource

entSource

)

RegisterXob()

void SCR_MapExporterPlugin.RegisterXob

(

BaseContainer

meshObjectComp

)

Run()

override void SCR_MapExporterPlugin.Run

(

)

Implements WorkbenchPlugin.

RunPrefabDiscovery()

void SCR_MapExporterPlugin.RunPrefabDiscovery

(

IEntitySource

prefab

)

Member Data Documentation

m_aCreatedFiles

ref TStringArray SCR_MapExporterPlugin.m_aCreatedFiles

m_AllowResourceCopy

bool SCR_MapExporterPlugin.m_AllowResourceCopy

m_bUsingAssetSuffixFallback

bool SCR_MapExporterPlugin.m_bUsingAssetSuffixFallback

m_Config

ref SCR_MapExporterConfig SCR_MapExporterPlugin.m_Config

m_ConfigResource

ResourceName SCR_MapExporterPlugin.m_ConfigResource

m_ExportDestination

string SCR_MapExporterPlugin.m_ExportDestination

m_mCreatedPrefabs

ref map<ResourceName,ResourceName> SCR_MapExporterPlugin.m_mCreatedPrefabs

m_mEntityClassBlacklist

ref map<string, string> SCR_MapExporterPlugin.m_mEntityClassBlacklist

m_mPrefabsNeedingReplace

ref map<ResourceName,bool> SCR_MapExporterPlugin.m_mPrefabsNeedingReplace

m_PerformExport

bool SCR_MapExporterPlugin.m_PerformExport

m_sConvertedAssetsSuffix

string SCR_MapExporterPlugin.m_sConvertedAssetsSuffix

m_sDiscoveredPrefabs

ref set<BaseContainer> SCR_MapExporterPlugin.m_sDiscoveredPrefabs

m_sMaterialsToMigrate

ref set<ResourceName> SCR_MapExporterPlugin.m_sMaterialsToMigrate

m_sMiscToMigrate

ref set<ResourceName> SCR_MapExporterPlugin.m_sMiscToMigrate

m_sModelsToMigrate

ref set<ResourceName> SCR_MapExporterPlugin.m_sModelsToMigrate

m_sPrefabsToMigrate

ref set<ResourceName> SCR_MapExporterPlugin.m_sPrefabsToMigrate

m_sResourceExcludeGUIDs

ref set<ResourceName> SCR_MapExporterPlugin.m_sResourceExcludeGUIDs

m_sTexturesToMigrate

ref set<ResourceName> SCR_MapExporterPlugin.m_sTexturesToMigrate

m_WEapi

WorldEditorAPI SCR_MapExporterPlugin.m_WEapi

m_WorldEditor

WorldEditor SCR_MapExporterPlugin.m_WorldEditor

resourceManager

ResourceManager SCR_MapExporterPlugin.resourceManager

SUFFIX_FALLBACK

const string SCR_MapExporterPlugin.SUFFIX_FALLBACK = "__DefExport"

static

---

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

• WorkbenchGameCommon/MapExporter.c