Adventure Creator  1.65.2
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2018
AC.Action Class Reference
Inheritance diagram for AC.Action:
AC.ActionAmbience AC.ActionAnim AC.ActionBlendShape AC.ActionCamera AC.ActionCameraCrossfade AC.ActionCameraShake AC.ActionCameraSplit AC.ActionCameraTP AC.ActionChangeMaterial AC.ActionCharAnim AC.ActionCharFace AC.ActionCharFaceDirection AC.ActionCharFollow AC.ActionCharHold AC.ActionCharMove AC.ActionCharPathFind AC.ActionCharPortrait AC.ActionCharRename AC.ActionCharRender AC.ActionCheck AC.ActionCheckMultiple AC.ActionCinemaDirector AC.ActionComment AC.ActionContainerOpen AC.ActionContainerSet AC.ActionDialogOption AC.ActionDialogOptionRename AC.ActionDocumentCollection AC.ActionDocumentOpen AC.ActionEndGame AC.ActionEvent AC.ActionFade AC.ActionFootstepSounds AC.ActionHighlight AC.ActionHotspotEnable AC.ActionInputActive AC.ActionInstantiate AC.ActionInteraction AC.ActionInventoryCrafting AC.ActionInventorySelect AC.ActionInventorySet AC.ActionInvProperty AC.ActionManageProfiles AC.ActionManageSaves AC.ActionMenuJournal AC.ActionMenuSelect AC.ActionMenuSetInputBox AC.ActionMenuState AC.ActionMixerSnapshot AC.ActionMovie AC.ActionMusic AC.ActionNavMesh AC.ActionParallel AC.ActionParamSet AC.ActionParent AC.ActionPause AC.ActionPauseActionList AC.ActionPlayerLock AC.ActionPlayerSwitch AC.ActionPlayMaker AC.ActionRename AC.ActionRunActionList AC.ActionSaveHandle AC.ActionScene AC.ActionSceneAdd AC.ActionSceneSwitchPrevious AC.ActionSendMessage AC.ActionSound AC.ActionSoundShot AC.ActionSpeech AC.ActionSpeechStop AC.ActionSpeechWait AC.ActionSpriteFade AC.ActionStopActionList AC.ActionSystemLock AC.ActionTeleport AC.ActionTemplate AC.ActionTimeline AC.ActionTimescale AC.ActionTintMap AC.ActionTrackSet AC.ActionTransform AC.ActionTransformRecord AC.ActionVarCopy AC.ActionVarPreset AC.ActionVarSet AC.ActionVisible AC.ActionVolume AC.ActionWaitMultiple

Public Member Functions

 Action ()
 
virtual float Run ()
 Runs the Action. More...
 
virtual void Skip ()
 
virtual ActionEnd End (List< Action > actions)
 Generates an ActionEnd class that describes what should happen after the Action has run. More...
 
void PrintComment (ActionList actionList)
 Prints the Action's comment, if applicable, to the Console. More...
 
virtual void ShowGUI (List< ActionParameter > parameters)
 Shows the Action's GUI when its parent ActionList / ActionListAsset uses parameters. More...
 
virtual void ShowGUI ()
 
virtual void SkipActionGUI (List< Action > actions, bool showGUI)
 
virtual void AssignConstantIDs (bool saveScriptsToo=false)
 Called when an ActionList has been converted from a scene-based object to an asset file. Within it, AssignConstantID should be called for each of the Action's Constant ID numbers, which will assign a new number if one does not already exist, based on the referenced scene object. More...
 
virtual string SetLabel ()
 Gets a string that is shown after the Action's title in the Editor to help the user understand what it does. More...
 
virtual void DrawOutWires (List< Action > actions, int i, int offset)
 
int FieldToID< T > (T field, int _constantID)
 
int FieldToID (Collider field, int _constantID)
 
void AddSaveScript< T > (Behaviour field)
 
void AddSaveScript< T > (GameObject _gameObject)
 
void AssignConstantID< T > (T field, int _constantID, int _parameterID)
 
void AssignConstantID (Collider field, int _constantID, int _parameterID)
 
void AssignConstantID (Transform field, int _constantID, int _parameterID)
 
void AssignConstantID (GameObject field, int _constantID, int _parameterID)
 
IDToField< T > (T field, int _constantID, bool moreInfo)
 
Collider IDToField (Collider field, int _constantID, bool moreInfo)
 
int FieldToID (Transform field, int _constantID)
 
Transform IDToField (Transform field, int _constantID, bool moreInfo)
 
int FieldToID (GameObject field, int _constantID)
 
int FieldToID (GameObject field, int _constantID, bool alwaysAssign)
 
GameObject IDToField (GameObject field, int _constantID, bool moreInfo)
 
GameObject IDToField (GameObject field, int _constantID, bool moreInfo, bool alwaysShow)
 
virtual bool ConvertLocalVariableToGlobal (int oldLocalID, int newGlobalID)
 Converts the Action's references from a given local variable to a given global variable More...
 
virtual bool ConvertGlobalVariableToLocal (int oldGlobalID, int newLocalID, bool isCorrectScene)
 Converts the Action's references from a given global variable to a given local variable More...
 
virtual int GetVariableReferences (List< ActionParameter > parameters, VariableLocation location, int varID)
 Gets the number of references the Action makes to a local or global variable More...
 
virtual int GetInventoryReferences (List< ActionParameter > parameters, int invID)
 
virtual void AssignParentList (ActionList actionList)
 Passes the ActionList that the Action is a part of to the Action class. This is run before the Action is called or displayed in an Editor. More...
 
virtual void AssignValues (List< ActionParameter > parameters)
 Overwrites any appropriate variables with values set using parameters, or from ConstantID numbers. More...
 
virtual void AssignValues ()
 
virtual void Reset (ActionList actionList)
 Resets any runtime values that are necessary to run the Action succesfully More...
 
Transform AssignFile (List< ActionParameter > parameters, int _parameterID, int _constantID, Transform field)
 Replaces a Transform based on an ActionParameter or ConstantID instance, if appropriate. More...
 
Collider AssignFile (List< ActionParameter > parameters, int _parameterID, int _constantID, Collider field)
 Replaces a Collider based on an ActionParameter or ConstantID instance, if appropriate. More...
 
AssignFile< T > (List< ActionParameter > parameters, int _parameterID, int _constantID, T field)
 Replaces a generic Behaviour based on an ActionParameter or ConstantID instance, if appropriate. More...
 
AssignFile< T > (int _constantID, T field)
 Replaces a generic Behaviour based on a ConstantID, if appropriate. More...
 
Transform AssignFile (int _constantID, Transform field)
 Replaces a Transform based on a ConstantID, if appropriate. More...
 
virtual void FixLinkAfterDeleting (Action actionToDelete, Action targetAction, List< Action > actionList)
 
virtual void ClearIDs ()
 
virtual void PrepareToCopy (int originalIndex, List< Action > actionList)
 
virtual void PrepareToPaste (int offset)
 
void BreakPoint (int i, ActionList list)
 
virtual void SetLastResult (ActionEnd _actionEnd)
 Sets the value of the lastResult ActionEnd. More...
 

Static Public Member Functions

static int ChooseParameterGUI (string label, List< ActionParameter > _parameters, int _parameterID, ParameterType _expectedType, int excludeParameterID=-1, string tooltip="")
 
static int ChooseParameterGUI (List< ActionParameter > _parameters, int _parameterID)
 

Public Attributes

int id
 
ActionCategory category = ActionCategory.Custom
 
string title
 
string description
 
bool isDisplayed
 
bool showComment
 
string comment
 
bool showOutputSockets = true
 
int numSockets = 1
 
bool willWait
 
bool isRunning
 
ActionEnd lastResult = new ActionEnd (-10)
 
ResultAction endAction = ResultAction.Continue
 
int skipAction = -1
 
AC.Action skipActionActual
 
Cutscene linkedCutscene
 
ActionListAsset linkedAsset
 
bool isEnabled = true
 
bool isAssetFile = false
 
bool isMarked = false
 
bool isBreakPoint = false
 
Rect nodeRect = new Rect (0,0,300,60)
 
float nodeHeight = 0f
 

Protected Member Functions

void AfterRunningOption ()
 
ActionParameter GetParameterWithID (List< ActionParameter > parameters, int _id)
 
string AssignString (List< ActionParameter > parameters, int _parameterID, string field)
 
BoolValue AssignBoolean (List< ActionParameter > parameters, int _parameterID, BoolValue field)
 
int AssignInteger (List< ActionParameter > parameters, int _parameterID, int field)
 
float AssignFloat (List< ActionParameter > parameters, int _parameterID, float field)
 
Vector3 AssignVector3 (List< ActionParameter > parameters, int _parameterID, Vector3 field)
 
int AssignVariableID (List< ActionParameter > parameters, int _parameterID, int field)
 
int AssignInvItemID (List< ActionParameter > parameters, int _parameterID, int field)
 
GameObject AssignFile (List< ActionParameter > parameters, int _parameterID, int _constantID, GameObject field)
 Replaces a GameObject based on an ActionParameter or ConstantID instance, if appropriate. More...
 
Object AssignObject< T > (List< ActionParameter > parameters, int _parameterID, Object field)
 Replaces a GameObject based on an ActionParameter or ConstantID instance, if appropriate. More...
 
GameObject AssignFile (int _constantID, GameObject field)
 Replaces a GameObject based on a ConstantID, if appropriate. More...
 
ActionEnd GenerateActionEnd (ResultAction _resultAction, ActionListAsset _linkedAsset, Cutscene _linkedCutscene, int _skipAction, Action _skipActionActual, List< Action > _actions)
 
ActionEnd GenerateStopActionEnd ()
 

Properties

float defaultPauseTime [get]
 

Detailed Description

The base class from which all Actions derive. An Action is a ScriptableObject that performs a specific command, like pausing the game or moving a character. They are chained together in ActionLists to form cutscenes, gameplay logic etc.

Constructor & Destructor Documentation

◆ Action()

AC.Action.Action ( )

The default Constructor.

Member Function Documentation

◆ AssignConstantIDs()

virtual void AC.Action.AssignConstantIDs ( bool  saveScriptsToo = false)
virtual

Called when an ActionList has been converted from a scene-based object to an asset file. Within it, AssignConstantID should be called for each of the Action's Constant ID numbers, which will assign a new number if one does not already exist, based on the referenced scene object.

Parameters
saveScriptsTooIf True, then the Action shall attempt to add the appropriate 'Remember' script to reference GameObjects as well.

Reimplemented in AC.ActionRunActionList, AC.ActionMovie, AC.ActionParamSet, AC.ActionParamCheck, AC.ActionPlayerSwitch, AC.ActionNavMesh, AC.ActionTransform, AC.ActionSpeech, AC.ActionCharMove, AC.ActionCharFace, AC.ActionTimeline, AC.ActionCharPathFind, AC.ActionInstantiate, AC.ActionBlendShape, AC.ActionTeleport, AC.ActionSound, AC.ActionContainerSet, AC.ActionCamera, AC.ActionContainerCheck, AC.ActionHighlight, AC.ActionScene, AC.ActionTintMap, AC.ActionConversation, AC.ActionSendMessage, AC.ActionCharAnim, AC.ActionCharFaceDirection, AC.ActionInteraction, AC.ActionCameraTP, AC.ActionCharRender, AC.ActionSceneSwitchPrevious, AC.ActionPauseActionList, AC.ActionAnim, AC.ActionCharHold, AC.ActionTrackSet, AC.ActionInteractionCheck, AC.ActionCharFollow, AC.ActionFootstepSounds, AC.ActionTransformRecord, AC.ActionCameraCrossfade, AC.ActionParent, AC.ActionDialogOption, AC.ActionCameraSplit, AC.ActionTrackCheck, AC.ActionCinemaDirector, AC.ActionDialogOptionRename, AC.ActionPlayMaker, AC.ActionSoundShot, AC.ActionCheckActionList, AC.ActionSpeechWait, AC.ActionChangeMaterial, AC.ActionVolume, AC.ActionHotspotEnable, AC.ActionSpriteFade, AC.ActionCharPortrait, AC.ActionVisible, AC.ActionStopActionList, AC.ActionContainerOpen, AC.ActionVisibleCheck, AC.ActionCharRename, AC.ActionRename, AC.ActionObjectCheck, and AC.ActionMoveableCheck.

◆ AssignFile() [1/5]

Transform AC.Action.AssignFile ( List< ActionParameter parameters,
int  _parameterID,
int  _constantID,
Transform  field 
)

Replaces a Transform based on an ActionParameter or ConstantID instance, if appropriate.

Parameters
parametersA List of ActionParameters that may override the Transform
_parameterIDThe ID of the ActionParameter to search for within parameters that will replace the Transform
_constantIDIf !=0, The ConstantID number of the Transform to replace field with
fieldThe Transform to replace
Returns
The replaced Transform, or field if no replacements were found

isAssetFile &&

◆ AssignFile() [2/5]

Collider AC.Action.AssignFile ( List< ActionParameter parameters,
int  _parameterID,
int  _constantID,
Collider  field 
)

Replaces a Collider based on an ActionParameter or ConstantID instance, if appropriate.

Parameters
parametersA List of ActionParameters that may override the Collider
_parameterIDThe ID of the ActionParameter to search for within parameters that will replace the Collider
_constantIDIf !=0, The ConstantID number of the Collider to replace field with
fieldThe Collider to replace
Returns
The replaced Collider, or field if no replacements were found

◆ AssignFile() [3/5]

GameObject AC.Action.AssignFile ( List< ActionParameter parameters,
int  _parameterID,
int  _constantID,
GameObject  field 
)
protected

Replaces a GameObject based on an ActionParameter or ConstantID instance, if appropriate.

Parameters
parametersA List of ActionParameters that may override the GameObject
_parameterIDThe ID of the ActionParameter to search for within parameters that will replace the GameObject
_constantIDIf !=0, The ConstantID number of the GameObject to replace field with
fieldThe GameObject to replace
Returns
The replaced GameObject, or field if no replacements were found

◆ AssignFile() [4/5]

GameObject AC.Action.AssignFile ( int  _constantID,
GameObject  field 
)
protected

Replaces a GameObject based on a ConstantID, if appropriate.

Parameters
_constantIDIf !=0, The ConstantID number of the GameObject to replace field with
fieldThe GameObject to replace
Returns
The replaced GameObject, or field if no replacements were found

◆ AssignFile() [5/5]

Transform AC.Action.AssignFile ( int  _constantID,
Transform  field 
)

Replaces a Transform based on a ConstantID, if appropriate.

Parameters
_constantIDIf !=0, The ConstantID number of the Transform to replace field with
fieldThe Transform to replace
Returns
The replaced Transform, or field if no replacements were found

◆ AssignFile< T >() [1/2]

T AC.Action.AssignFile< T > ( List< ActionParameter parameters,
int  _parameterID,
int  _constantID,
field 
)

Replaces a generic Behaviour based on an ActionParameter or ConstantID instance, if appropriate.

Parameters
parametersA List of ActionParameters that may override the Behaviour
_parameterIDThe ID of the ActionParameter to search for within parameters that will replace the Behaviour
_constantIDIf !=0, The ConstantID number of the Behaviour to replace field with
fieldThe Behaviour to replace
Returns
The replaced Behaviour, or field if no replacements were found
Type Constraints
T :Behaviour 

◆ AssignFile< T >() [2/2]

T AC.Action.AssignFile< T > ( int  _constantID,
field 
)

Replaces a generic Behaviour based on a ConstantID, if appropriate.

Parameters
_constantIDIf !=0, The ConstantID number of the Behaviour to replace field with
fieldThe Behaviour to replace
Returns
The replaced Behaviour, or field if no replacements were found
Type Constraints
T :Behaviour 

◆ AssignObject< T >()

Object AC.Action.AssignObject< T > ( List< ActionParameter parameters,
int  _parameterID,
Object  field 
)
protected

Replaces a GameObject based on an ActionParameter or ConstantID instance, if appropriate.

Parameters
parametersA List of ActionParameters that may override the GameObject
_parameterIDThe ID of the ActionParameter to search for within parameters that will replace the GameObject
fieldThe Object to replace
Returns
The replaced Object, or field if no replacements were found
Type Constraints
T :Object 

◆ AssignParentList()

virtual void AC.Action.AssignParentList ( ActionList  actionList)
virtual

Passes the ActionList that the Action is a part of to the Action class. This is run before the Action is called or displayed in an Editor.

Parameters
actionListThe ActionList that the Action is contained in

Reimplemented in AC.ActionNavMesh, AC.ActionSpeech, AC.ActionVarSet, AC.ActionVarCheck, AC.ActionInvProperty, AC.ActionMenuState, AC.ActionVarCopy, AC.ActionSceneCheckAttribute, AC.ActionVarSequence, AC.ActionVarPreset, AC.ActionMenuCheck, and AC.ActionVarPopup.

◆ AssignValues() [1/2]

virtual void AC.Action.AssignValues ( List< ActionParameter parameters)
virtual

Overwrites any appropriate variables with values set using parameters, or from ConstantID numbers.

Parameters
parametersA List of parameters that overwrite variable values

Reimplemented in AC.ActionMovie, AC.ActionAnim, AC.ActionCharAnim, AC.ActionMenuState, AC.ActionSpeech, AC.ActionRunActionList, AC.ActionTransform, AC.ActionVarSet, AC.ActionParamSet, AC.ActionVarCheck, AC.ActionParamCheck, AC.ActionTeleport, AC.ActionInventoryCheck, AC.ActionTimeline, AC.ActionCheckActionList, AC.ActionInstantiate, AC.ActionMenuCheck, AC.ActionCharRender, AC.ActionInventorySet, AC.ActionCharPathFind, AC.ActionContainerSet, AC.ActionQTE, AC.ActionNavMesh, AC.ActionCharMove, AC.ActionInvProperty, AC.ActionSendMessage, AC.ActionCharFace, AC.ActionContainerCheck, AC.ActionParent, AC.ActionSaveHandle, AC.ActionCameraTP, AC.ActionCharFollow, AC.ActionCameraSplit, AC.ActionSound, AC.ActionTintMap, AC.ActionTrackSet, AC.ActionInventorySelect, AC.ActionVarCopy, AC.ActionAmbience, AC.ActionBlendShape, AC.ActionHighlight, AC.ActionManageProfiles, AC.ActionMusic, AC.ActionSaveCheck, AC.ActionSceneCheck, AC.ActionCamera, AC.ActionCharHold, AC.ActionInventoryCheckSelected, AC.ActionMenuSetInputBox, AC.ActionPauseActionList, AC.ActionScene, AC.ActionManageSaves, AC.ActionPlayMaker, AC.ActionFootstepSounds, AC.ActionMenuJournal, AC.ActionSceneAdd, AC.ActionTrackCheck, AC.ActionTransformRecord, AC.ActionVarSequence, AC.ActionCharFaceDirection, AC.ActionMenuSlotCheck, AC.ActionCameraCrossfade, AC.ActionChangeMaterial, AC.ActionFade, AC.ActionRandomCheck, AC.ActionVolume, AC.ActionCharRename, AC.ActionInputCheck, AC.ActionInteraction, AC.ActionRename, AC.ActionCameraShake, AC.ActionCharPortrait, AC.ActionInteractionCheck, AC.ActionMenuSelect, AC.ActionSceneSwitchPrevious, AC.ActionSoundShot, AC.ActionStopActionList, AC.ActionVarPreset, AC.ActionCinemaDirector, AC.ActionContainerOpen, AC.ActionConversation, AC.ActionHotspotEnable, AC.ActionSpeechWait, AC.ActionSpriteFade, AC.ActionVisible, AC.ActionVisibleCheck, AC.ActionObjectCheck, AC.ActionMoveableCheck, and AC.ActionPause.

◆ AssignValues() [2/2]

virtual void AC.Action.AssignValues ( )
virtual

Overwrites any appropriate variables from ConstantID numbers.

Reimplemented in AC.ActionPlayerSwitch, AC.ActionDialogOption, and AC.ActionDialogOptionRename.

◆ ConvertGlobalVariableToLocal()

virtual bool AC.Action.ConvertGlobalVariableToLocal ( int  oldGlobalID,
int  newLocalID,
bool  isCorrectScene 
)
virtual

Converts the Action's references from a given global variable to a given local variable

Parameters
oldGlobalIDThe ID number of the old global variable
newLocalIDThe ID number of the new local variable
isCorrectSceneIf True, the local variable is in the same scene as this ActionList. Otherwise, no change will made, but the return value will be the same
Returns
True if the Action is affected

Reimplemented in AC.ActionVarSet, AC.ActionVarCheck, AC.ActionMenuState, AC.ActionSpeech, AC.ActionInvProperty, AC.ActionVarCopy, AC.ActionVarSequence, AC.ActionRandomCheck, AC.ActionVarPopup, AC.ActionMenuSetInputBox, AC.ActionDialogOptionRename, and AC.ActionComment.

◆ ConvertLocalVariableToGlobal()

virtual bool AC.Action.ConvertLocalVariableToGlobal ( int  oldLocalID,
int  newGlobalID 
)
virtual

Converts the Action's references from a given local variable to a given global variable

Parameters
oldLocalIDThe ID number of the old local variable
newGlobalIDThe ID number of the new global variable
Returns
True if the Action was amended

Reimplemented in AC.ActionVarSet, AC.ActionVarCheck, AC.ActionMenuState, AC.ActionSpeech, AC.ActionInvProperty, AC.ActionVarCopy, AC.ActionVarSequence, AC.ActionVarPopup, AC.ActionRandomCheck, AC.ActionMenuSetInputBox, AC.ActionDialogOptionRename, and AC.ActionComment.

◆ End()

virtual ActionEnd AC.Action.End ( List< Action actions)
virtual

Generates an ActionEnd class that describes what should happen after the Action has run.

Parameters
actionsThe List of Actions that the Action is a part of
Returns
An ActionEnd class that describes what should happen after the Action has run

Reimplemented in AC.ActionSaveHandle, AC.ActionScene, AC.ActionSceneSwitchPrevious, AC.ActionEndGame, AC.ActionVarSequence, AC.ActionCheck, AC.ActionVarPopup, AC.ActionRandomCheck, AC.ActionCheckMultiple, AC.ActionWaitMultiple, and AC.ActionCheckMultipleTemplate.

◆ GetVariableReferences()

virtual int AC.Action.GetVariableReferences ( List< ActionParameter parameters,
VariableLocation  location,
int  varID 
)
virtual

Gets the number of references the Action makes to a local or global variable

Parameters
parametersThe List of ActionParameters associated with the ActionList that contains the Action
locationThe variable's location (Global, Local)
varIDThe variable's ID number
Returns
The number of references the Action makes to the variable

Reimplemented in AC.ActionVarSet, AC.ActionRunActionList, AC.ActionVarCheck, AC.ActionParamSet, AC.ActionParamCheck, AC.ActionMenuState, AC.ActionSpeech, AC.ActionInvProperty, AC.ActionVarCopy, AC.ActionVarSequence, AC.ActionVarPopup, AC.ActionRandomCheck, AC.ActionMenuSetInputBox, AC.ActionDialogOptionRename, and AC.ActionComment.

◆ PrintComment()

void AC.Action.PrintComment ( ActionList  actionList)

Prints the Action's comment, if applicable, to the Console.

Parameters
actionListThe associated ActionList of which this Action is a part of

◆ Reset()

virtual void AC.Action.Reset ( ActionList  actionList)
virtual

Resets any runtime values that are necessary to run the Action succesfully

Parameters
actionListThe ActionList that the Action is a part of<param>

Reimplemented in AC.ActionWaitMultiple.

◆ Run()

virtual float AC.Action.Run ( )
virtual

Runs the Action.

Returns
The time, in seconds, to wait before ActionList calls this function again. If 0, then the Action will not be re-run. If >0, and isRunning = True, then the Action will be re-run isRunning = False

Reimplemented in AC.ActionParamSet, AC.ActionAnim, AC.ActionMovie, AC.ActionTransform, AC.ActionNavMesh, AC.ActionRunActionList, AC.ActionSpeech, AC.ActionVarSet, AC.ActionCharAnim, AC.ActionPlayerSwitch, AC.ActionCharMove, AC.ActionInstantiate, AC.ActionMenuState, AC.ActionTintMap, AC.ActionCharPathFind, AC.ActionTeleport, AC.ActionTimeline, AC.ActionCharHold, AC.ActionInvProperty, AC.ActionSendMessage, AC.ActionChangeMaterial, AC.ActionCharRender, AC.ActionCharFace, AC.ActionContainerSet, AC.ActionPlayMaker, AC.ActionVarCopy, AC.ActionBlendShape, AC.ActionInventorySet, AC.ActionParent, AC.ActionQTE, AC.ActionSound, AC.ActionFootstepSounds, AC.ActionHighlight, AC.ActionTrackSet, AC.ActionVarPreset, AC.ActionCameraTP, AC.ActionCharFollow, AC.ActionSaveHandle, AC.ActionCameraSplit, AC.ActionMenuSetInputBox, AC.ActionPauseActionList, AC.ActionAmbience, AC.ActionCameraCrossfade, AC.ActionCharFaceDirection, AC.ActionInventorySelect, AC.ActionMusic, AC.ActionScene, AC.ActionCamera, AC.ActionManageProfiles, AC.ActionCharRename, AC.ActionMenuJournal, AC.ActionCameraShake, AC.ActionCharPortrait, AC.ActionManageSaves, AC.ActionSceneAdd, AC.ActionContainerOpen, AC.ActionSpeechWait, AC.ActionTransformRecord, AC.ActionVolume, AC.ActionFade, AC.ActionStopActionList, AC.ActionMenuSelect, AC.ActionCinemaDirector, AC.ActionInputCheck, AC.ActionInteraction, AC.ActionRename, AC.ActionSoundShot, AC.ActionSystemLock, AC.ActionSceneSwitchPrevious, AC.ActionConversation, AC.ActionDialogOption, AC.ActionDialogOptionRename, AC.ActionHotspotEnable, AC.ActionPlayerLock, AC.ActionSpriteFade, AC.ActionVisible, AC.ActionCheckActionList, AC.ActionComment, AC.ActionEndGame, AC.ActionMixerSnapshot, AC.ActionPause, AC.ActionDocumentCollection, AC.ActionEvent, AC.ActionDocumentOpen, AC.ActionInputActive, AC.ActionTimescale, AC.ActionSpeechStop, AC.ActionTemplate, AC.ActionInventoryCrafting, and AC.ActionWaitMultiple.

◆ SetLabel()

virtual string AC.Action.SetLabel ( )
virtual

Gets a string that is shown after the Action's title in the Editor to help the user understand what it does.

Returns
A string that is shown after the Action's title in the Editor to help the user understand what it does.

Reimplemented in AC.ActionRunActionList, AC.ActionVarSet, AC.ActionMovie, AC.ActionParamSet, AC.ActionVarCheck, AC.ActionParamCheck, AC.ActionMenuState, AC.ActionPlayerSwitch, AC.ActionNavMesh, AC.ActionTransform, AC.ActionCharMove, AC.ActionSpeech, AC.ActionCharFace, AC.ActionTimeline, AC.ActionInvProperty, AC.ActionInstantiate, AC.ActionCharPathFind, AC.ActionSceneCheckAttribute, AC.ActionInventoryCheck, AC.ActionSaveHandle, AC.ActionTeleport, AC.ActionVarCopy, AC.ActionInventorySet, AC.ActionManageProfiles, AC.ActionSound, AC.ActionQTE, AC.ActionContainerSet, AC.ActionCamera, AC.ActionContainerCheck, AC.ActionInventoryCheckSelected, AC.ActionSaveCheck, AC.ActionHighlight, AC.ActionAmbience, AC.ActionMusic, AC.ActionScene, AC.ActionConversation, AC.ActionTintMap, AC.ActionSendMessage, AC.ActionCharFaceDirection, AC.ActionBlendShape, AC.ActionInteraction, AC.ActionCharHold, AC.ActionCameraTP, AC.ActionCharRender, AC.ActionPauseActionList, AC.ActionCharFollow, AC.ActionCharAnim, AC.ActionTrackSet, AC.ActionParent, AC.ActionFootstepSounds, AC.ActionInteractionCheck, AC.ActionInventorySelect, AC.ActionVarPreset, AC.ActionTransformRecord, AC.ActionCameraCrossfade, AC.ActionFade, AC.ActionManageSaves, AC.ActionAnim, AC.ActionSceneAdd, AC.ActionCameraSplit, AC.ActionInputCheck, AC.ActionMixerSnapshot, AC.ActionCinemaDirector, AC.ActionTrackCheck, AC.ActionCameraShake, AC.ActionPlayMaker, AC.ActionCheckActionList, AC.ActionSoundShot, AC.ActionSpeechWait, AC.ActionChangeMaterial, AC.ActionVarPopup, AC.ActionMenuCheck, AC.ActionVolume, AC.ActionEndGame, AC.ActionMenuJournal, AC.ActionMenuSlotCheck, AC.ActionPlayerCheck, AC.ActionCharPortrait, AC.ActionMenuSetInputBox, AC.ActionHotspotEnable, AC.ActionSpriteFade, AC.ActionVisible, AC.ActionStopActionList, AC.ActionCharRename, AC.ActionContainerOpen, AC.ActionVisibleCheck, AC.ActionMenuSelect, AC.ActionRename, AC.ActionTemplate, AC.ActionComment, AC.ActionMoveableCheck, AC.ActionPause, AC.ActionDocumentCollection, AC.ActionSpeechStop, AC.ActionDocumentOpen, AC.ActionInventoryCrafting, AC.ActionCheckMultipleTemplate, and AC.ActionCheckTemplate.

◆ SetLastResult()

virtual void AC.Action.SetLastResult ( ActionEnd  _actionEnd)
virtual

Sets the value of the lastResult ActionEnd.

Parameters
_actionEndThe ActionEnd to copy onto lastResult

Reimplemented in AC.ActionCheckActionList.

◆ ShowGUI() [1/2]

virtual void AC.Action.ShowGUI ( List< ActionParameter parameters)
virtual

Shows the Action's GUI when its parent ActionList / ActionListAsset uses parameters.

Parameters
parametersA List of parameters available in the parent ActionList / ActionListAsset

Reimplemented in AC.ActionMovie, AC.ActionRunActionList, AC.ActionParamCheck, AC.ActionVarSet, AC.ActionMenuState, AC.ActionVarCheck, AC.ActionCharMove, AC.ActionParamSet, AC.ActionSpeech, AC.ActionCharFace, AC.ActionCharPathFind, AC.ActionTransform, AC.ActionSaveHandle, AC.ActionNavMesh, AC.ActionInstantiate, AC.ActionSound, AC.ActionTimeline, AC.ActionManageProfiles, AC.ActionSaveCheck, AC.ActionTeleport, AC.ActionCamera, AC.ActionQTE, AC.ActionCharFaceDirection, AC.ActionInventoryCheck, AC.ActionSendMessage, AC.ActionVarSequence, AC.ActionTintMap, AC.ActionAnim, AC.ActionScene, AC.ActionInputCheck, AC.ActionCameraTP, AC.ActionCharAnim, AC.ActionConversation, AC.ActionContainerSet, AC.ActionHighlight, AC.ActionPauseActionList, AC.ActionSceneSwitchPrevious, AC.ActionFade, AC.ActionContainerCheck, AC.ActionTrackSet, AC.ActionInventoryCheckSelected, AC.ActionInvProperty, AC.ActionVarCopy, AC.ActionCameraCrossfade, AC.ActionCameraShake, AC.ActionManageSaves, AC.ActionSceneAdd, AC.ActionBlendShape, AC.ActionInventorySet, AC.ActionTransformRecord, AC.ActionAmbience, AC.ActionMusic, AC.ActionInteraction, AC.ActionCinemaDirector, AC.ActionCharHold, AC.ActionRandomCheck, AC.ActionSceneCheck, AC.ActionCharRender, AC.ActionSoundShot, AC.ActionTrackCheck, AC.ActionMenuCheck, AC.ActionMenuSlotCheck, AC.ActionCheckActionList, AC.ActionMenuJournal, AC.ActionParent, AC.ActionSpeechWait, AC.ActionPlayMaker, AC.ActionVarPopup, AC.ActionInteractionCheck, AC.ActionHotspotEnable, AC.ActionFootstepSounds, AC.ActionInventorySelect, AC.ActionMenuSetInputBox, AC.ActionChangeMaterial, AC.ActionSpriteFade, AC.ActionCameraSplit, AC.ActionCharFollow, AC.ActionVisible, AC.ActionVarPreset, AC.ActionVolume, AC.ActionMenuSelect, AC.ActionVisibleCheck, AC.ActionCharPortrait, AC.ActionStopActionList, AC.ActionCharRename, AC.ActionContainerOpen, AC.ActionDocumentCollection, AC.ActionPause, AC.ActionInputActive, AC.ActionParallel, AC.ActionRename, AC.ActionObjectCheck, AC.ActionDocumentOpen, and AC.ActionMoveableCheck.

◆ ShowGUI() [2/2]

◆ Skip()

Member Data Documentation

◆ category

ActionCategory AC.Action.category = ActionCategory.Custom

The category (ActionList, Camera, Character, Container, Dialogue, Engine, Hotspot, Input, Inventory, Menu, Moveable, Object, Player, Save, Sound, ThirdParty, Variable, Custom)

◆ comment

string AC.Action.comment

A user-defined comment about the Action's purpose

◆ description

string AC.Action.description

A brief description about what the Action does

◆ endAction

ResultAction AC.Action.endAction = ResultAction.Continue

What happens when the Action ends (Continue, Stop, Skip, RunCutscene)

◆ id

int AC.Action.id

A unique identifier

◆ isAssetFile

bool AC.Action.isAssetFile = false

If True, the Action is stored within an ActionListAsset file

◆ isBreakPoint

bool AC.Action.isBreakPoint = false

If True, the Editor will pause when this Action is run in-game

◆ isDisplayed

bool AC.Action.isDisplayed

If True, the Action is expanded in the Editor

◆ isEnabled

bool AC.Action.isEnabled = true

If True, the Action is enabled and can be run

◆ isMarked

bool AC.Action.isMarked = false

If True, the Action has been marked for modification in ActionListEditorWindow

◆ isRunning

bool AC.Action.isRunning

If True, then the Action is running

◆ lastResult

ActionEnd AC.Action.lastResult = new ActionEnd (-10)

What happened the last time the Action was run (used when skipping Actions)

◆ linkedAsset

ActionListAsset AC.Action.linkedAsset

The ActionListAsset to run, if resultAction = ResultAction.RunCutscene and the Action is in an ActionListAsset file

◆ linkedCutscene

Cutscene AC.Action.linkedCutscene

The Cutscene to run, if resultAction = ResultAction.RunCutscene and the Action is in a scene-based ActionList

◆ nodeRect

Rect AC.Action.nodeRect = new Rect (0,0,300,60)

The Action's node Rect within the ActionListEditorWindow

◆ numSockets

int AC.Action.numSockets = 1

How many output sockets the Action has

◆ showComment

bool AC.Action.showComment

If True, then the comment text will be shown in the Action's UI in the ActionList Editor window

◆ showOutputSockets

bool AC.Action.showOutputSockets = true

If True, then output sockets and wires will be visible when the Action is viewed within the ActionList Editor window

◆ skipAction

int AC.Action.skipAction = -1

The index number of the Action to skip to, if resultAction = ResultAction.Skip

◆ skipActionActual

AC.Action AC.Action.skipActionActual

The Action to skip to, if resultAction = ResultAction.Skip

◆ title

string AC.Action.title

The Action's title

◆ willWait

bool AC.Action.willWait

If True, the ActionList will wait until the Action has finished running before continuing