SCR_GameModeSetupPlugin Interface Reference

Inheritance diagram for SCR_GameModeSetupPlugin:

Public Member Functions
override void	Run ()

Protected Member Functions
void	RunValidation ()
void	RunValidationResults ()
void	RunGeneration ()
void	RunGenerationResults ()
void	RunMissionHeader ()
void	RunMissionHeaderResults ()
void	RunOutro ()
void	ShowPage (SCR_EGameModeSetupPage page)
void	ShowPrevPage ()
bool	LoadConfig (out string error)
bool	ButtonCancel ()
bool	ButtonNext ()

Protected Attributes
ResourceName	m_sTemplate
ref GameModeSetupConfig	m_Config
bool	m_bIsWorldValid
bool	m_bIsWorldAttentionNeeded
bool	m_bCanAutogenerateWorld
bool	m_bIsMissionHeaderValid
ref array< SCR_EGameModeSetupPage >	m_aPageHistory = { SCR_EGameModeSetupPage.INTRO }
string	m_sDialogMessageValidation
string	m_sDialogMessageGeneration
string	m_sDialogMessageMissionHeader

Static Protected Attributes
static const string	CAPTION_INTRO = "Game Mode Setup"
static const string	CAPTION_VALIDATION = "Game Mode Setup - World Scan"
static const string	CAPTION_VALIDATION_RESULTS = "Game Mode Setup - World Scan Results"
static const string	CAPTION_GENERATION = "Game Mode Setup - World Configuration"
static const string	CAPTION_GENERATION_RESULTS = "Game Mode Setup - World Configuration Completed"
static const string	CAPTION_MISSION_HEADER = "Game Mode Setup - Mission Header"
static const string	CAPTION_MISSION_HEADER_RESULTS = "Game Mode Setup - Mission Header Created"
static const string	CAPTION_OUTRO_GOOD = "Game Mode Setup - Success"
static const string	CAPTION_OUTRO_BAD = "Game Mode Setup - Actions Required"
static const string	DESCRIPTION_INTRO = "Welcome to step-by-step setup of a game mode.\nA game mode is a set of rules that define how the world will function.\nWithout it, players won't be able to try your world in game.\nEven opening the world in Game Master requires you to create a Game Master game mode for it.\n\nThe plugin will explain what's needed to get a game mode up an running,\nand offer automatic creation of required configuration.\n\nBefore we start, please select a template of the game mode you wish to set up.\n"
static const string	DESCRIPTION_VALIDATION = "To know what needs to be configured the plugin will scan all entities currently present in the world.\nDepending on the size of the world, this may take several seconds or minutes.\n\nYou can decide to skip this step, but unless you understand how to set up game mode manually,\nit's better to let the plugin check the current status first."
static const string	DESCRIPTION_VALIDATION_RESULTS = "All entities scanned, results are listed below:\n"
static const string	DESCRIPTION_GENERATION = "The plugin can now create required entities in the world.\nThey will be created in the current layer, but you can later move them to any other layer."
static const string	DESCRIPTION_GENERATION_RESULTS = "Required entities were created in the current layer.\nTry to re-scan the world to see if nothing is missing anymore.\n"
static const string	DESCRIPTION_MISSION_HEADER = "For the game mode to appear in main menu's scenario list, it needs a mission header.\nIt's a config file which exists outside of the world, but points to it.\n\nIn this step you can let the plugin create the file automatically."
static const string	DESCRIPTION_MISSION_HEADER_RESULTS = ""
static const string	DESCRIPTION_OUTRO_COMPLETE = "Congratulations, the game mode is configured correctly.\n\nGive it a try and hit that Play button!"
static const string	DESCRIPTION_OUTRO_INCOMPLETE = "Configuration was not finished.\nTo ensure the game mode is set up correctly, please fix all issues and go through each step again."

Member Function Documentation

ButtonCancel()

bool SCR_GameModeSetupPlugin.ButtonCancel ( )

protected

ButtonNext()

bool SCR_GameModeSetupPlugin.ButtonNext ( )

protected

LoadConfig()

bool SCR_GameModeSetupPlugin.LoadConfig ( out string error )

protected

Run()

override void SCR_GameModeSetupPlugin.Run

(

)

RunGeneration()

void SCR_GameModeSetupPlugin.RunGeneration ( )

protected

RunGenerationResults()

void SCR_GameModeSetupPlugin.RunGenerationResults ( )

protected

RunMissionHeader()

void SCR_GameModeSetupPlugin.RunMissionHeader ( )

protected

RunMissionHeaderResults()

void SCR_GameModeSetupPlugin.RunMissionHeaderResults ( )

protected

RunOutro()

void SCR_GameModeSetupPlugin.RunOutro ( )

protected

RunValidation()

void SCR_GameModeSetupPlugin.RunValidation ( )

protected

RunValidationResults()

void SCR_GameModeSetupPlugin.RunValidationResults ( )

protected

ShowPage()

void SCR_GameModeSetupPlugin.ShowPage ( SCR_EGameModeSetupPage page )

protected

ShowPrevPage()

void SCR_GameModeSetupPlugin.ShowPrevPage ( )

protected

Member Data Documentation

CAPTION_GENERATION

const string SCR_GameModeSetupPlugin.CAPTION_GENERATION = "Game Mode Setup - World Configuration"

staticprotected

CAPTION_GENERATION_RESULTS

const string SCR_GameModeSetupPlugin.CAPTION_GENERATION_RESULTS = "Game Mode Setup - World Configuration Completed"

staticprotected

CAPTION_INTRO

const string SCR_GameModeSetupPlugin.CAPTION_INTRO = "Game Mode Setup"

staticprotected

CAPTION_MISSION_HEADER

const string SCR_GameModeSetupPlugin.CAPTION_MISSION_HEADER = "Game Mode Setup - Mission Header"

staticprotected

CAPTION_MISSION_HEADER_RESULTS

const string SCR_GameModeSetupPlugin.CAPTION_MISSION_HEADER_RESULTS = "Game Mode Setup - Mission Header Created"

staticprotected

CAPTION_OUTRO_BAD

const string SCR_GameModeSetupPlugin.CAPTION_OUTRO_BAD = "Game Mode Setup - Actions Required"

staticprotected

CAPTION_OUTRO_GOOD

const string SCR_GameModeSetupPlugin.CAPTION_OUTRO_GOOD = "Game Mode Setup - Success"

staticprotected

CAPTION_VALIDATION

const string SCR_GameModeSetupPlugin.CAPTION_VALIDATION = "Game Mode Setup - World Scan"

staticprotected

CAPTION_VALIDATION_RESULTS

const string SCR_GameModeSetupPlugin.CAPTION_VALIDATION_RESULTS = "Game Mode Setup - World Scan Results"

staticprotected

DESCRIPTION_GENERATION

const string SCR_GameModeSetupPlugin.DESCRIPTION_GENERATION = "The plugin can now create required entities in the world.\nThey will be created in the current layer, but you can later move them to any other layer."

staticprotected

DESCRIPTION_GENERATION_RESULTS

const string SCR_GameModeSetupPlugin.DESCRIPTION_GENERATION_RESULTS = "Required entities were created in the current layer.\nTry to re-scan the world to see if nothing is missing anymore.\n"

staticprotected

DESCRIPTION_INTRO

const string SCR_GameModeSetupPlugin.DESCRIPTION_INTRO = "Welcome to step-by-step setup of a game mode.\nA game mode is a set of rules that define how the world will function.\nWithout it, players won't be able to try your world in game.\nEven opening the world in Game Master requires you to create a Game Master game mode for it.\n\nThe plugin will explain what's needed to get a game mode up an running,\nand offer automatic creation of required configuration.\n\nBefore we start, please select a template of the game mode you wish to set up.\n"

staticprotected

DESCRIPTION_MISSION_HEADER

const string SCR_GameModeSetupPlugin.DESCRIPTION_MISSION_HEADER = "For the game mode to appear in main menu's scenario list, it needs a mission header.\nIt's a config file which exists outside of the world, but points to it.\n\nIn this step you can let the plugin create the file automatically."

staticprotected

DESCRIPTION_MISSION_HEADER_RESULTS

const string SCR_GameModeSetupPlugin.DESCRIPTION_MISSION_HEADER_RESULTS = ""

staticprotected

DESCRIPTION_OUTRO_COMPLETE

const string SCR_GameModeSetupPlugin.DESCRIPTION_OUTRO_COMPLETE = "Congratulations, the game mode is configured correctly.\n\nGive it a try and hit that Play button!"

staticprotected

DESCRIPTION_OUTRO_INCOMPLETE

const string SCR_GameModeSetupPlugin.DESCRIPTION_OUTRO_INCOMPLETE = "Configuration was not finished.\nTo ensure the game mode is set up correctly, please fix all issues and go through each step again."

staticprotected

DESCRIPTION_VALIDATION

const string SCR_GameModeSetupPlugin.DESCRIPTION_VALIDATION = "To know what needs to be configured the plugin will scan all entities currently present in the world.\nDepending on the size of the world, this may take several seconds or minutes.\n\nYou can decide to skip this step, but unless you understand how to set up game mode manually,\nit's better to let the plugin check the current status first."

staticprotected

DESCRIPTION_VALIDATION_RESULTS

const string SCR_GameModeSetupPlugin.DESCRIPTION_VALIDATION_RESULTS = "All entities scanned, results are listed below:\n"

staticprotected

m_aPageHistory

ref array<SCR_EGameModeSetupPage> SCR_GameModeSetupPlugin.m_aPageHistory = { SCR_EGameModeSetupPage.INTRO }

protected

m_bCanAutogenerateWorld

bool SCR_GameModeSetupPlugin.m_bCanAutogenerateWorld

protected

m_bIsMissionHeaderValid

bool SCR_GameModeSetupPlugin.m_bIsMissionHeaderValid

protected

m_bIsWorldAttentionNeeded

bool SCR_GameModeSetupPlugin.m_bIsWorldAttentionNeeded

protected

m_bIsWorldValid

bool SCR_GameModeSetupPlugin.m_bIsWorldValid

protected

m_Config

ref GameModeSetupConfig SCR_GameModeSetupPlugin.m_Config

protected

m_sDialogMessageGeneration

string SCR_GameModeSetupPlugin.m_sDialogMessageGeneration

protected

m_sDialogMessageMissionHeader

string SCR_GameModeSetupPlugin.m_sDialogMessageMissionHeader

protected

m_sDialogMessageValidation

string SCR_GameModeSetupPlugin.m_sDialogMessageValidation

protected

m_sTemplate

ResourceName SCR_GameModeSetupPlugin.m_sTemplate

protected

---

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

• WorkbenchGame/WorldEditor/GameModeSetup/SCR_GameModeSetupPlugin.c