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

Public Types

enum  AC_EndGameType { QuitGame, LoadAutosave, ResetScene, RestartGame }
 

Public Member Functions

override float Run ()
 Runs the Action. More...
 
override ActionEnd End (List< Action > actions)
 Generates an ActionEnd class that describes what should happen after the Action has run. More...
 
override void ShowGUI ()
 
override 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...
 
- Public Member Functions inherited from AC.Action
 Action ()
 
virtual void Skip ()
 
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 SkipActionGUI (List< Action > actions, bool showGUI)
 
virtual void AssignConstantIDs (bool saveScriptsToo=false, bool fromAssetFile=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 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 GetVariableReferences (List< ActionParameter > parameters, VariableLocation location, int varID, Variables variables)
 
virtual int GetInventoryReferences (List< ActionParameter > parameters, int invID)
 
virtual int GetDocumentReferences (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...
 
BoolValue AssignBoolean (List< ActionParameter > parameters, int _parameterID, BoolValue field)
 Replaces a boolean based on an ActionParameter, if appropriate. More...
 
int AssignInteger (List< ActionParameter > parameters, int _parameterID, int field)
 Replaces an integer based on an ActionParameter, if appropriate. More...
 
float AssignFloat (List< ActionParameter > parameters, int _parameterID, float field)
 Replaces a float based on an ActionParameter, if appropriate. 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...
 

Public Attributes

AC_EndGameType endGameType
 
ChooseSceneBy chooseSceneBy = ChooseSceneBy.Number
 
int sceneNumber
 
string sceneName
 
bool resetMenus
 
- Public Attributes inherited from AC.Action
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
 
Color overrideColor = Color.white
 

Additional Inherited Members

- Static Public Member Functions inherited from AC.Action
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)
 
static int FieldToID (GameObject field, int _constantID, bool alwaysAssign, bool _isAssetFile)
 
static GameObject IDToField (GameObject field, int _constantID, bool moreInfo, bool alwaysShow, bool _isAssetFile)
 
- Protected Member Functions inherited from AC.Action
void AfterRunningOption ()
 
ActionParameter GetParameterWithID (List< ActionParameter > parameters, int _id)
 
string AssignString (List< ActionParameter > parameters, int _parameterID, string field)
 
Vector3 AssignVector3 (List< ActionParameter > parameters, int _parameterID, Vector3 field)
 
int AssignVariableID (List< ActionParameter > parameters, int _parameterID, int field)
 
GVar AssignVariable (List< ActionParameter > parameters, int _parameterID, GVar field)
 
Variables AssignVariablesComponent (List< ActionParameter > parameters, int _parameterID, Variables field)
 
int AssignInvItemID (List< ActionParameter > parameters, int _parameterID, int field)
 
int AssignDocumentID (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 inherited from AC.Action
float defaultPauseTime [get]
 

Member Function Documentation

◆ End()

override ActionEnd AC.ActionEndGame.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 from AC.Action.

◆ Run()

override float AC.ActionEndGame.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 from AC.Action.

◆ SetLabel()

override string AC.ActionEndGame.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 from AC.Action.

◆ ShowGUI()

override void AC.ActionEndGame.ShowGUI ( )
virtual

Shows the Action's GUI.

Reimplemented from AC.Action.