Role Selection Control Role Parameters

Detailed Description

Collaboration diagram for Role Selection Control Role Parameters:

Variables
constexpr const char *	makVre::RoleSelectionControlConfig::availableRolesAttributeName = "availableRolesAttributeName"
constexpr const char *	makVre::RoleSelectionControlConfig::excludedRoles = "excludedRoles"
constexpr const char *	makVre::RoleSelectionControlConfig::hasAvailableRolesAttributeName = "hasAvailableRolesAttributeName"
constexpr const char *	makVre::RoleSelectionControlConfig::inputConfigFile = "inputConfigFile"
constexpr const char *	makVre::RoleSelectionControlConfig::inputConfigGroup = "inputConfigGroup"
constexpr const char *	makVre::RoleSelectionControlConfig::nextRoleBinding = "nextRoleBinding"
constexpr const char *	makVre::RoleSelectionControlConfig::previousRoleBinding = "previousRoleBinding"
constexpr const char *	makVre::RoleSelectionControlConfig::rolesList = "rolesList"
constexpr const char *	makVre::RoleSelectionControlConfig::selectRoleMenuAction = "selectRoleMenuAction"

Variable Documentation

availableRolesAttributeName

const char* makVre::RoleSelectionControlConfig::availableRolesAttributeName = "availableRolesAttributeName"

constexpr

Parameter Name	availableRolesAttributeName
Parameter Description	Name of the state attribute that stores the list of available role names for selection.
Parameter Type	string
Parameter Default	"availableRoles"
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   availableRolesAttributeName = "availableRoles"; 
   ... 
};

excludedRoles

const char* makVre::RoleSelectionControlConfig::excludedRoles = "excludedRoles"

constexpr

Parameter Name	excludedRoles
Parameter Description	Table of role names to exclude from the available roles list.
Parameter Type	table
Parameter Default	{}
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   excludedRoles = {}; 
   ... 
};

hasAvailableRolesAttributeName

const char* makVre::RoleSelectionControlConfig::hasAvailableRolesAttributeName = "hasAvailableRolesAttributeName"

constexpr

Parameter Name	hasAvailableRolesAttributeName
Parameter Description	Name of the boolean state attribute indicating whether any roles are available for selection.
Parameter Type	string
Parameter Default	"hasAvailableRoles"
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   hasAvailableRolesAttributeName = "hasAvailableRoles"; 
   ... 
};

inputConfigFile

const char* makVre::RoleSelectionControlConfig::inputConfigFile = "inputConfigFile"

constexpr

Parameter Name	inputConfigFile
Parameter Description	Input configuration file path for role selection key bindings.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   inputConfigFile = ""; 
   ... 
};

inputConfigGroup

const char* makVre::RoleSelectionControlConfig::inputConfigGroup = "inputConfigGroup"

constexpr

Parameter Name	inputConfigGroup
Parameter Description	Input configuration group name for role selection controls.
Parameter Type	string
Parameter Default	"general"
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   inputConfigGroup = "general"; 
   ... 
};

nextRoleBinding

const char* makVre::RoleSelectionControlConfig::nextRoleBinding = "nextRoleBinding"

constexpr

Parameter Name	nextRoleBinding
Parameter Description	Input binding name for selecting the next available role.
Parameter Type	string
Parameter Default	"next-role"
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   nextRoleBinding = "next-role"; 
   ... 
};

previousRoleBinding

const char* makVre::RoleSelectionControlConfig::previousRoleBinding = "previousRoleBinding"

constexpr

Parameter Name	previousRoleBinding
Parameter Description	Input binding name for selecting the previous available role.
Parameter Type	string
Parameter Default	"previous-role"
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   previousRoleBinding = "previous-role"; 
   ... 
};

rolesList

const char* makVre::RoleSelectionControlConfig::rolesList = "rolesList"

constexpr

Parameter Name	rolesList
Parameter Description	Table of specific role names to include in the role selection list (overrides automatic discovery).
Parameter Type	table
Parameter Default	{}
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   rolesList = {}; 
   ... 
};

selectRoleMenuAction

const char* makVre::RoleSelectionControlConfig::selectRoleMenuAction = "selectRoleMenuAction"

constexpr

Parameter Name	selectRoleMenuAction
Parameter Description	Menu action name for triggering role selection via the menu system.
Parameter Type	string
Parameter Default	"selectRole"
Required?	No

Example Role Config Usage:

["roleSelectionControl"] = { 
   ... 
   selectRoleMenuAction = "selectRole"; 
   ... 
};