SCR_WorldSetupPlugin_GenericWorldEntity Interface Reference

This Plugin is experimental because it directly writes in the layer file, expecting a certain directory structure and file format. More...

Inheritance diagram for SCR_WorldSetupPlugin_GenericWorldEntity:

Public Member Functions
override void	Run ()

Protected Member Functions
string	GetDefaultLayerAbsoluteFilePath (string worldPath, string worldName)
	Get the path to the default layer (worldDir/worldName_Layers/default.layer)
bool	ButtonOK ()
bool	ButtonCancel ()
Protected Member Functions inherited from SCR_WorldSetupPluginBasePlugin
ResourceName	CreatePrefabChildInAddon (ResourceName prefab, int addon, string fileName=string.Empty)
	Create a child to the provided Prefab - uses the provided Prefab on error.

Protected Attributes
ResourceName	m_sWorldEntityPrefab
bool	m_bCopyPrefabToAddon
int	m_iAddon

Static Protected Attributes
static const string	CHILD_PREFAB = "%1_%2"
static const string	LAYERS_DIR = "%1_Layers"
static const string	DEFAULT_LAYER = "default.layer"
static const string	WORLD_ENTITY_CLASS = "GenericWorldEntity"

Detailed Description

This Plugin is experimental because it directly writes in the layer file, expecting a certain directory structure and file format.

An engine solution should be provided for this matter.

Member Function Documentation

ButtonCancel()

bool SCR_WorldSetupPlugin_GenericWorldEntity.ButtonCancel ( )

protected

ButtonOK()

bool SCR_WorldSetupPlugin_GenericWorldEntity.ButtonOK ( )

protected

GetDefaultLayerAbsoluteFilePath()

string SCR_WorldSetupPlugin_GenericWorldEntity.GetDefaultLayerAbsoluteFilePath ( string  worldPath, string  worldName  )

protected

Get the path to the default layer (worldDir/worldName_Layers/default.layer)

Parameters

[in]	worldPath	world's directory
[in]	worldName	world's name (used to determine layers directory)

Returns

path to the default layer

Run()

override void SCR_WorldSetupPlugin_GenericWorldEntity.Run

(

)

Member Data Documentation

CHILD_PREFAB

const string SCR_WorldSetupPlugin_GenericWorldEntity.CHILD_PREFAB = "%1_%2"

staticprotected

DEFAULT_LAYER

const string SCR_WorldSetupPlugin_GenericWorldEntity.DEFAULT_LAYER = "default.layer"

staticprotected

LAYERS_DIR

const string SCR_WorldSetupPlugin_GenericWorldEntity.LAYERS_DIR = "%1_Layers"

staticprotected

m_bCopyPrefabToAddon

bool SCR_WorldSetupPlugin_GenericWorldEntity.m_bCopyPrefabToAddon

protected

m_iAddon

int SCR_WorldSetupPlugin_GenericWorldEntity.m_iAddon

protected

m_sWorldEntityPrefab

ResourceName SCR_WorldSetupPlugin_GenericWorldEntity.m_sWorldEntityPrefab

protected

WORLD_ENTITY_CLASS

const string SCR_WorldSetupPlugin_GenericWorldEntity.WORLD_ENTITY_CLASS = "GenericWorldEntity"

staticprotected

---

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

• WorkbenchGame/WorldEditor/WorldSetup/SCR_WorldSetupPlugin_GenericWorldEntity.c