Enfusion Script API
Loading...
Searching...
No Matches
WorldExporterPlugin Interface Reference
Inheritance diagram for WorldExporterPlugin:
WorkbenchPlugin Managed

Public Member Functions

override void Run ()
 
void PerformExport ()
 
override void Configure ()
 
WorldExporterConfig GetConfig (ResourceName configPath)
 
bool AddAssetToMigrate (ExporterAssetType type, ResourceName resource, ResourceName resSource=string.Empty)
 
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 RegisterGamemat (ResourceName resName)
 
void RunPrefabDiscovery (IEntitySource prefab)
 
void ProcessEntityRecur (IEntitySource entSource, IEntitySource parent, bool parentToBeDeleted, array< IEntitySource > toReparent=null)
 
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 CopyContainerProperties (BaseContainer sourceContainer, BaseContainer targetContainer, BaseContainer targetEntity, array< ref ContainerIdPathEntry > path)
 
void CopyComponents (IEntitySource source, IEntitySource target)
 
void CopyComponent (string componentName, IEntitySource source, IEntitySource target)
 
void CopyContainerPropertiesSpecial (string componentName, BaseContainer sourceComponent, BaseContainer targetComponent, BaseContainer targetEntity, array< ref ContainerIdPathEntry > path)
 
void ExportFiles (set< ResourceName > resourceNames)
 
void ExportFile (string srcFilePath)
 
void ExportMapData ()
 
void ExportSharedData ()
 
IEntitySource CloneSingleEntity (string className, IEntitySource oldEntSrc, IEntitySource parent, int layerID=0)
 
void OnBeforeEntityProcessed (IEntitySource source)
 
void OnAfterEntityProcessed (IEntitySource source)
 
void OnAfterEntityCloned (IEntitySource oldEntSrc, IEntitySource newEntSrc)
 
void OnAfterEntityReparented (IEntitySource source, IEntitySource newParent)
 
void CopyEntityProperties (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 RunCommandline ()
 
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
 
bool m_CrawlFromRootResources
 
ref WorldExporterConfig m_Config
 
WorldEditor m_WorldEditor
 
ref map< string, stringm_mEntityClassBlacklist
 
ref map< ResourceName, ResourceNamem_mCreatedPrefabs
 
ref TStringArray m_aCreatedFiles
 
ref set< BaseContainerm_sDiscoveredPrefabs
 
ref map< ResourceName, boolm_mPrefabsNeedingReplace
 
ref set< ResourceNamem_sPrefabsToMigrate
 
ref set< ResourceNamem_sModelsToMigrate
 
ref set< ResourceNamem_sMaterialsToMigrate
 
ref set< ResourceNamem_sTexturesToMigrate
 
ref set< ResourceNamem_sMiscToMigrate
 
ref set< ResourceNamem_sResourceExcludeGUIDs
 
ref set< ResourceNamem_sGamematsToMigrate
 
ref WorldExportScript MapSpecificScript
 
WorldEditorAPI m_WEapi
 
ResourceManager resourceManager
 
bool m_PerformExport
 
string m_sFilesystem
 

Protected Member Functions

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

Member Function Documentation

◆ AddAssetToMigrate()

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

◆ ButtonExport()

bool WorldExporterPlugin.ButtonExport ( )
protected

◆ ClearExportSourceData()

void WorldExporterPlugin.ClearExportSourceData ( )

◆ CloneEntityFull()

IEntitySource WorldExporterPlugin.CloneEntityFull ( IEntitySource entSource,
IEntitySource parent )

◆ ClonePrefabFast()

ResourceName WorldExporterPlugin.ClonePrefabFast ( BaseContainer prefab)
protected

◆ ClonePrefabSlow()

ResourceName WorldExporterPlugin.ClonePrefabSlow ( notnull BaseContainer originalPrefab)
protected

◆ CloneSingleEntity()

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

◆ Configure()

override void WorldExporterPlugin.Configure ( )

Implements WorkbenchPlugin.

◆ CopyComponent()

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

◆ CopyComponents()

void WorldExporterPlugin.CopyComponents ( IEntitySource source,
IEntitySource target )

◆ CopyContainerProperties()

void WorldExporterPlugin.CopyContainerProperties ( BaseContainer sourceContainer,
BaseContainer targetContainer,
BaseContainer targetEntity,
array< ref ContainerIdPathEntry > path )

◆ CopyContainerPropertiesSpecial()

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

◆ CopyEntityProperties()

void WorldExporterPlugin.CopyEntityProperties ( IEntitySource oldEntSrc,
IEntitySource newEntSrc )

◆ DeepPrefabEntityCloneRecur()

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

◆ DeleteFilePlus()

void WorldExporterPlugin.DeleteFilePlus ( string path)

◆ DiscoverMeshObjectMaterialOverrides()

void WorldExporterPlugin.DiscoverMeshObjectMaterialOverrides ( BaseContainer meshContainer,
ResourceName resourceName )

◆ DoesEntityNeedReplacing()

bool WorldExporterPlugin.DoesEntityNeedReplacing ( IEntitySource entSource)

◆ DoesPrefabNeedReplacing()

bool WorldExporterPlugin.DoesPrefabNeedReplacing ( BaseContainer prefab)

◆ DoesPrefabNeedReplacingFast()

bool WorldExporterPlugin.DoesPrefabNeedReplacingFast ( BaseContainer prefab)

◆ ExportFile()

void WorldExporterPlugin.ExportFile ( string srcFilePath)

◆ ExportFiles()

void WorldExporterPlugin.ExportFiles ( set< ResourceName > resourceNames)

◆ ExportMapData()

void WorldExporterPlugin.ExportMapData ( )

◆ ExportSharedData()

void WorldExporterPlugin.ExportSharedData ( )

◆ FindComponentSource()

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

◆ GetAlternateClassName()

string WorldExporterPlugin.GetAlternateClassName ( string currentName)

◆ GetConfig()

WorldExporterConfig WorldExporterPlugin.GetConfig ( ResourceName configPath)

◆ GetMaterialsFromXobs()

void WorldExporterPlugin.GetMaterialsFromXobs ( )

◆ GetPrefab()

static BaseContainer WorldExporterPlugin.GetPrefab ( BaseContainer source)
static

◆ GetPrefabName()

static ResourceName WorldExporterPlugin.GetPrefabName ( BaseContainer source)
static

◆ GetTexturesFromMaterials()

void WorldExporterPlugin.GetTexturesFromMaterials ( )

◆ Init()

bool WorldExporterPlugin.Init ( )
protected

◆ InitVars()

void WorldExporterPlugin.InitVars ( )
protected

◆ IsAnyComponentIncompatible()

bool WorldExporterPlugin.IsAnyComponentIncompatible ( notnull IEntitySource entSource)

◆ IsComponentClassBlacklisted()

bool WorldExporterPlugin.IsComponentClassBlacklisted ( string className)

◆ IsEntityClassBlacklisted()

bool WorldExporterPlugin.IsEntityClassBlacklisted ( IEntitySource entSource)

◆ IsExportTargetFolderEmpty()

bool WorldExporterPlugin.IsExportTargetFolderEmpty ( )

◆ IsFromPrefabLibrary()

bool WorldExporterPlugin.IsFromPrefabLibrary ( ResourceName prefab)

◆ IsPartOfPrefab()

bool WorldExporterPlugin.IsPartOfPrefab ( IEntitySource entSource)

◆ OnAfterEntityCloned()

void WorldExporterPlugin.OnAfterEntityCloned ( IEntitySource oldEntSrc,
IEntitySource newEntSrc )

◆ OnAfterEntityProcessed()

void WorldExporterPlugin.OnAfterEntityProcessed ( IEntitySource source)

◆ OnAfterEntityReparented()

void WorldExporterPlugin.OnAfterEntityReparented ( IEntitySource source,
IEntitySource newParent )

◆ OnBeforeEntityProcessed()

void WorldExporterPlugin.OnBeforeEntityProcessed ( IEntitySource source)

◆ PerformExport()

void WorldExporterPlugin.PerformExport ( )

◆ PerformResourceExport()

void WorldExporterPlugin.PerformResourceExport ( WBProgressDialog dialog)

◆ ProcessDiscoveredPrefabs()

void WorldExporterPlugin.ProcessDiscoveredPrefabs ( )

◆ ProcessEntityRecur()

void WorldExporterPlugin.ProcessEntityRecur ( IEntitySource entSource,
IEntitySource parent,
bool parentToBeDeleted,
array< IEntitySource > toReparent = null )

◆ RegisterGamemat()

void WorldExporterPlugin.RegisterGamemat ( ResourceName resName)

◆ RegisterMaterial()

void WorldExporterPlugin.RegisterMaterial ( ResourceName resName)

◆ RegisterNewPrefab()

void WorldExporterPlugin.RegisterNewPrefab ( ResourceName resNameOriginal,
ResourceName resNameNew )

◆ RegisterPrefabXob()

void WorldExporterPlugin.RegisterPrefabXob ( IEntitySource entSource)

◆ RegisterXob()

void WorldExporterPlugin.RegisterXob ( BaseContainer meshObjectComp)

◆ Run()

override void WorldExporterPlugin.Run ( )

Implements WorkbenchPlugin.

◆ RunPrefabDiscovery()

void WorldExporterPlugin.RunPrefabDiscovery ( IEntitySource prefab)

Member Data Documentation

◆ m_aCreatedFiles

ref TStringArray WorldExporterPlugin.m_aCreatedFiles

◆ m_AllowResourceCopy

bool WorldExporterPlugin.m_AllowResourceCopy

◆ m_Config

ref WorldExporterConfig WorldExporterPlugin.m_Config

◆ m_ConfigResource

ResourceName WorldExporterPlugin.m_ConfigResource

◆ m_CrawlFromRootResources

bool WorldExporterPlugin.m_CrawlFromRootResources

◆ m_ExportDestination

string WorldExporterPlugin.m_ExportDestination

◆ m_mCreatedPrefabs

ref map<ResourceName,ResourceName> WorldExporterPlugin.m_mCreatedPrefabs

◆ m_mEntityClassBlacklist

ref map<string, string> WorldExporterPlugin.m_mEntityClassBlacklist

◆ m_mPrefabsNeedingReplace

ref map<ResourceName,bool> WorldExporterPlugin.m_mPrefabsNeedingReplace

◆ m_PerformExport

bool WorldExporterPlugin.m_PerformExport

◆ m_sDiscoveredPrefabs

ref set<BaseContainer> WorldExporterPlugin.m_sDiscoveredPrefabs

◆ m_sFilesystem

string WorldExporterPlugin.m_sFilesystem

◆ m_sGamematsToMigrate

ref set<ResourceName> WorldExporterPlugin.m_sGamematsToMigrate

◆ m_sMaterialsToMigrate

ref set<ResourceName> WorldExporterPlugin.m_sMaterialsToMigrate

◆ m_sMiscToMigrate

ref set<ResourceName> WorldExporterPlugin.m_sMiscToMigrate

◆ m_sModelsToMigrate

ref set<ResourceName> WorldExporterPlugin.m_sModelsToMigrate

◆ m_sPrefabsToMigrate

ref set<ResourceName> WorldExporterPlugin.m_sPrefabsToMigrate

◆ m_sResourceExcludeGUIDs

ref set<ResourceName> WorldExporterPlugin.m_sResourceExcludeGUIDs

◆ m_sTexturesToMigrate

ref set<ResourceName> WorldExporterPlugin.m_sTexturesToMigrate

◆ m_WEapi

WorldEditorAPI WorldExporterPlugin.m_WEapi

◆ m_WorldEditor

WorldEditor WorldExporterPlugin.m_WorldEditor

◆ MapSpecificScript

ref WorldExportScript WorldExporterPlugin.MapSpecificScript

◆ resourceManager

ResourceManager WorldExporterPlugin.resourceManager

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