AC.RuntimeActionList Class Reference

Inheritance diagram for AC.RuntimeActionList:

Public Member Functions
void	DownloadActions (ActionListAsset actionListAsset, Conversation endConversation, int i, bool doSkip, bool addToSkipQueue, bool dontRun=false)
	Downloads and runs the settings and Actions stored within an ActionListAsset.
override void	Kill ()
void	DestroySelf ()
Public Member Functions inherited from AC.ActionList
void	Initialise ()
void	StopSkipping ()
virtual void	Interact ()
void	RunFromIndex (int index)
	Runs the Actions from a set point.
void	Interact (int i, bool addToSkipQueue)
	Runs the Actions from a set point.
void	Skip ()
void	Skip (int i)
	Runs the Actions instantly, from a set point.
bool	AreActionsRunning ()
	Checks if any Actions are currently being run.
void	ResetList ()
bool	IsSkippable ()
	Checks if the ActionListAsset is skippable. This is safer than just reading 'isSkippable', because it also accounts for actionListType - since ActionLists that run in the background cannot be skipped.
List< Action >	GetActions ()
	Gets the List of Actions that this ActionList runs, regardless of source.
ActionParameter	GetParameter (string label)
	Gets a parameter of a given name.
ActionParameter	GetParameter (int _ID)
	Gets a parameter of a given ID number.
void	Pause ()
void	Resume (int _startIndex, int[] _resumeIndices, string _parameterData, bool rerunPreviousAction=false)
	Resumes the ActionList.
string	GetParameterData ()
	Gets the current ActionParameter values as a serializable string.
void	SetParameterData (string dataString)
	Assigns parameter values based on a string generated by the GetParameterData function.
int	GetNumItemReferences (int itemID)
int	UpdateItemReferences (int oldItemID, int newItemID)
int	GetNumMenuReferences (string menuName, string elementName="")
int	GetNumVariableReferences (VariableLocation _location, int variableID, Variables _variables=null, int _variablesConstantID=0)
int	UpdateVariableReferences (VariableLocation _location, int oldVariableID, int newVariableID, Variables _variables=null, int _variablesConstantID=0)
int	GetNumDocumentReferences (int documentID)
int	UpdateDocumentReferences (int oldDocumentID, int newDocumentID)
int	GetNumObjectiveReferences (int objectiveID)
int	UpdateObjectiveReferences (int oldObjectiveID, int newObjectiveID)
bool	ReferencesAsset (ActionListAsset actionListAsset)
List< ActionListAsset >	GetReferencedActionListAssets ()
bool	ActionModified (int index)

Public Attributes
ActionListAsset	assetSource
Public Attributes inherited from AC.ActionList
List< AC.Action >	actions = new List<AC.Action> ()
bool	isSkippable = true
float	triggerTime = 0f
bool	autosaveAfter = false
ActionListType	actionListType = ActionListType.PauseGameplay
Conversation	conversation = null
ActionListAsset	assetFile
ActionListSource	source
bool	unfreezePauseMenus = true
bool	useParameters = false
List< ActionParameter >	parameters = new List<ActionParameter> ()
int	tagID
bool	syncParamValues = true
List< ActionGroup >	groups = new List<ActionGroup> ()

Protected Member Functions
void	OnEnable ()
void	OnDisable ()
override void	BeginActionList (int i, bool addToSkipQueue)
override void	AddResumeToManager (int startIndex)
override void	ReturnLastResultToSource (int index, int i)
override void	FinishPause ()
override void	PrintActionComment (Action action)
void	OnBeforeChangeScene (string nextSceneName)
void	OnAfterChangeScene (LoadingGame loadingGame)
Protected Member Functions inherited from AC.ActionList
void	ProcessAction (int i)
void	CheckEndCutscene ()

Additional Inherited Members
Static Public Member Functions inherited from AC.ActionList
static AC.Action	GetDefaultAction ()
	Gets the default Action set within ActionsManager.
Static Public Attributes inherited from AC.ActionList
static string	logSuffix
Protected Attributes inherited from AC.ActionList
bool	isSkipping = false
LayerMask	LayerHotspot
LayerMask	LayerOff
List< int >	resumeIndices = new List<int> ()
bool	isChangingScene = false
Properties inherited from AC.ActionList
int	NumParameters [get]
bool	IsSkipping [get]

Detailed Description

An ActionList subclass used to run ActionListAssets, which exist in asset files outside of the scene. When an ActionListAsset is run, its Actions are copied to a new RuntimeActionList and run locally.

Member Function Documentation

AddResumeToManager()

override void AC.RuntimeActionList.AddResumeToManager ( int startIndex )

protectedvirtual

Reimplemented from AC.ActionList.

BeginActionList()

override void AC.RuntimeActionList.BeginActionList ( int i, bool addToSkipQueue )

protectedvirtual

Reimplemented from AC.ActionList.

DestroySelf()

void AC.RuntimeActionList.DestroySelf

(

)

Destroys itself.

DownloadActions()

void AC.RuntimeActionList.DownloadActions	(	ActionListAsset	actionListAsset,
		Conversation	endConversation,
		int	i,
		bool	doSkip,
		bool	addToSkipQueue,
		bool	dontRun = false )

Downloads and runs the settings and Actions stored within an ActionListAsset.

Parameters

actionListAsset	The ActionListAsset to copy Actions from and run
endConversation	If set, the supplied Conversation will be run when the AcionList ends
i	The index number of the first Action to run
doSkip	If True, then the Actions will be skipped, instead of run normally
addToSkipQueue	If True, the ActionList will be skippable when the user presses 'EndCutscene'
dontRun	If True, the Actions will not be run once transferred from the ActionListAsset

FinishPause()

override void AC.RuntimeActionList.FinishPause ( )

protectedvirtual

Reimplemented from AC.ActionList.

Kill()

override void AC.RuntimeActionList.Kill ( )

virtual

Stops the Actions from running and sets the gameState in StateHandler to the correct value.

Reimplemented from AC.ActionList.

PrintActionComment()

override void AC.RuntimeActionList.PrintActionComment ( Action action )

protectedvirtual

Reimplemented from AC.ActionList.

ReturnLastResultToSource()

override void AC.RuntimeActionList.ReturnLastResultToSource ( int index, int i )

protectedvirtual

Reimplemented from AC.ActionList.

Member Data Documentation

assetSource

ActionListAsset AC.RuntimeActionList.assetSource

The ActionListAsset that this ActionList's Actions are copied from