Adventure Creator  1.67.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2018
AC.ActionsManager Class Reference
Inheritance diagram for AC.ActionsManager:

Public Member Functions

string GetDefaultAction ()
 Gets the filename of the default Action. More...
 
void ShowGUI ()
 
string GetActionTypeLabel (Action _action, bool includeLabel)
 
string GetActionTypeLabel (Action _action)
 
string GetActionName (int i)
 Gets the filename of an enabled Action. More...
 
bool DoesActionExist (string _name)
 Checks if any enabled Actions have a specific filename. More...
 
int GetActionsSize ()
 Gets the number of enabled Actions. More...
 
string [] GetActionTitles ()
 Gets all Action titles within EnabledActions. More...
 
int GetActionTypeIndex (Action _action)
 Gets the index number of an Action within EnabledActions. More...
 
int GetEnabledActionTypeIndex (ActionCategory _category, int subCategoryIndex)
 Gets the index number of an Action within EnabledActions. More...
 
string [] GetActionSubCategories (ActionCategory _category)
 Gets all found Action titles within a given ActionCategory. More...
 
ActionCategory GetActionCategory (int number)
 Gets the ActionCategory of an Action within EnabledActions. More...
 
int GetActionSubCategory (Action _action)
 Gets the index of an Action within a list of all Actions that share its category. More...
 
ActionType [] GetActionTypesInCategory (ActionCategory category)
 Gets all found ActionType classes that belong in a given category More...
 
bool IsActionTypeEnabled (int index)
 
Color GetActionTypeColor (Action _action)
 

Public Attributes

string customFolderPath = "AdventureCreator/Scripts/Actions"
 
bool displayActionsInInspector = true
 
DisplayActionsInEditor displayActionsInEditor = DisplayActionsInEditor.ArrangedVertically
 
bool allowMultipleActionListWindows = false
 
ActionListEditorScrollWheel actionListEditorScrollWheel = ActionListEditorScrollWheel.PansWindow
 
bool invertPanning = false
 
float panSpeed = 1f
 
bool autoPanNearWindowEdge = true
 
int defaultClass
 
string defaultClassName
 
List< ActionTypeAllActions = new List<ActionType>()
 

Properties

string FolderPath [get]
 
bool UsingCustomActionsFolder [get]
 

Detailed Description

Handles the "Actions" tab of the Game Editor window. All available Actions are listed here, and custom Actions can be added.

Member Function Documentation

◆ DoesActionExist()

bool AC.ActionsManager.DoesActionExist ( string  _name)

Checks if any enabled Actions have a specific filename.

Parameters
_nameThe filename to check for
Returns
True if any enabled Actions have the supplied filename

◆ GetActionCategory()

ActionCategory AC.ActionsManager.GetActionCategory ( int  number)

Gets the ActionCategory of an Action within EnabledActions.

Parameters
numberThe index number of the Action's place in EnabledActions
Returns
The ActionCategory of the Action

◆ GetActionName()

string AC.ActionsManager.GetActionName ( int  i)

Gets the filename of an enabled Action.

Parameters
iThe index number of the Action, in EnabledActions, to get the filename of
Returns
Gets the filename of the Action

◆ GetActionsSize()

int AC.ActionsManager.GetActionsSize ( )

Gets the number of enabled Actions.

Returns
The number of enabled Actions

◆ GetActionSubCategories()

string [] AC.ActionsManager.GetActionSubCategories ( ActionCategory  _category)

Gets all found Action titles within a given ActionCategory.

Parameters
_categoryThe category of the Actions to get the titles of.
Returns
A string array of all Action titles within the ActionCategory

◆ GetActionSubCategory()

int AC.ActionsManager.GetActionSubCategory ( Action  _action)

Gets the index of an Action within a list of all Actions that share its category.

Parameters
_actionThe Action to get the index of
Returns
The index of the Action within a list of all Actions that share its category

◆ GetActionTitles()

string [] AC.ActionsManager.GetActionTitles ( )

Gets all Action titles within EnabledActions.

Returns
A string array of all Action titles within EnabledActions

◆ GetActionTypeIndex()

int AC.ActionsManager.GetActionTypeIndex ( Action  _action)

Gets the index number of an Action within EnabledActions.

Parameters
_actionThe Action to search for
Returns
The index number of the Action within EnabledActions

◆ GetActionTypesInCategory()

ActionType [] AC.ActionsManager.GetActionTypesInCategory ( ActionCategory  category)

Gets all found ActionType classes that belong in a given category

Parameters
categoryThe category of ActionType classes to collect

<retuns>An array of all ActionType classes that belong in the given category

◆ GetDefaultAction()

string AC.ActionsManager.GetDefaultAction ( )

Gets the filename of the default Action.

Returns
The filename of the default Action.

◆ GetEnabledActionTypeIndex()

int AC.ActionsManager.GetEnabledActionTypeIndex ( ActionCategory  _category,
int  subCategoryIndex 
)

Gets the index number of an Action within EnabledActions.

Parameters
_categoryThe category of the Action to search for
subCategoryIndexThe index number of the Action in a list of all Actions that share its category
Returns
The index number of the Action within EnabledActions

Member Data Documentation

◆ actionListEditorScrollWheel

ActionListEditorScrollWheel AC.ActionsManager.actionListEditorScrollWheel = ActionListEditorScrollWheel.PansWindow

The effect the mouse scrollwheel has inside the ActionList Editor window (PansWindow, ZoomsWindow)

◆ AllActions

List<ActionType> AC.ActionsManager.AllActions = new List<ActionType>()

A List of all Action classes found

◆ allowMultipleActionListWindows

bool AC.ActionsManager.allowMultipleActionListWindows = false

If True, then multiple ActionList Editor windows can be opened at once

◆ autoPanNearWindowEdge

bool AC.ActionsManager.autoPanNearWindowEdge = true

If True, the ActionList Editor will pan automatically when dragging the cursor near the window's edge

◆ customFolderPath

string AC.ActionsManager.customFolderPath = "AdventureCreator/Scripts/Actions"

The folder path to any custom Actions

◆ defaultClass

int AC.ActionsManager.defaultClass

The index number of the default Action (deprecated)

◆ defaultClassName

string AC.ActionsManager.defaultClassName

The class name of the default Action

◆ displayActionsInEditor

DisplayActionsInEditor AC.ActionsManager.displayActionsInEditor = DisplayActionsInEditor.ArrangedVertically

How Actions are arranged in the ActionList Editor window (ArrangedVertically, ArrangedHorizontally)

◆ displayActionsInInspector

bool AC.ActionsManager.displayActionsInInspector = true

If True, then Actions can be displayed in an ActionList's Inspector window

◆ invertPanning

bool AC.ActionsManager.invertPanning = false

If True, then panning is inverted in the ActionList Editor window (useful for Macbooks)

◆ panSpeed

float AC.ActionsManager.panSpeed = 1f

The speed factor for panning/zooming

Property Documentation

◆ FolderPath

string AC.ActionsManager.FolderPath
get

The folder path to the default Actions