Saved View Updater Role Parameters

Detailed Description

Collaboration diagram for Saved View Updater Role Parameters:

Variables
constexpr const char *	SavedViewUpdaterConfig::allowChangingViews = "allowChangingViews"
constexpr const char *	SavedViewUpdaterConfig::channelName = "channelName"
constexpr const char *	SavedViewUpdaterConfig::hideHumanInSavedViews = "hideHumanInSavedViews"
constexpr const char *	SavedViewUpdaterConfig::initialView = "initialView"
constexpr const char *	SavedViewUpdaterConfig::observerName = "observerName"
constexpr const char *	SavedViewUpdaterConfig::savedViews = "savedViews"
constexpr const char *	SavedViewUpdaterConfig::showCockpits = "showCockpits"
constexpr const char *	SavedViewUpdaterConfig::viewChannelKeywordMap = "viewChannelKeywordMap"
constexpr const char *	SavedViewUpdaterConfig::windowName = "windowName"

Variable Documentation

allowChangingViews

const char* SavedViewUpdaterConfig::allowChangingViews = "allowChangingViews"

constexpr

Parameter Name	allowChangingViews
Parameter Description	Determines whether the player is allowed to change between saved views.
Parameter Type	bool
Parameter Default	true
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   allowChangingViews = true; 
   ... 
};

channelName

const char* SavedViewUpdaterConfig::channelName = "channelName"

constexpr

Parameter Name	channelName
Parameter Description	Name of the channel to update with view keywords.
Parameter Type	string
Parameter Default	"Channel 1"
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   channelName = "Channel 1"; 
   ... 
};

hideHumanInSavedViews

const char* SavedViewUpdaterConfig::hideHumanInSavedViews = "hideHumanInSavedViews"

constexpr

Parameter Name	hideHumanInSavedViews
Parameter Description	Table specifying which saved views should hide the human model during walk-on embarkation.
Parameter Type	table
Parameter Default	""
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   hideHumanInSavedViews = ""; 
   ... 
};

initialView

const char* SavedViewUpdaterConfig::initialView = "initialView"

constexpr

Parameter Name	initialView
Parameter Description	Name of the initial saved view to activate on startup.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   initialView = ""; 
   ... 
};

observerName

const char* SavedViewUpdaterConfig::observerName = "observerName"

constexpr

Parameter Name	observerName
Parameter Description	Name of the observer to use for saved view management.
Parameter Type	string
Parameter Default	"Observer 1"
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   observerName = "Observer 1"; 
   ... 
};

savedViews

const char* SavedViewUpdaterConfig::savedViews = "savedViews"

constexpr

Parameter Name	savedViews
Parameter Description	Path to the file containing saved view definitions.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   savedViews = ""; 
   ... 
};

showCockpits

const char* SavedViewUpdaterConfig::showCockpits = "showCockpits"

constexpr

Parameter Name	showCockpits
Parameter Description	Determines whether cockpit models should be visible in saved views.
Parameter Type	bool
Parameter Default	false
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   showCockpits = false; 
   ... 
};

viewChannelKeywordMap

const char* SavedViewUpdaterConfig::viewChannelKeywordMap = "viewChannelKeywordMap"

constexpr

Parameter Name	viewChannelKeywordMap
Parameter Description	Table mapping saved view names to channel keywords for view-specific display settings.
Parameter Type	table
Parameter Default	""
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   viewChannelKeywordMap = ""; 
   ... 
};

windowName

const char* SavedViewUpdaterConfig::windowName = "windowName"

constexpr

Parameter Name	windowName
Parameter Description	Name of the window containing the channel to update.
Parameter Type	string
Parameter Default	"Window 1"
Required?	No

Example Role Config Usage:

["savedViewUpdater"] = { 
   ... 
   windowName = "Window 1"; 
   ... 
};