Adventure Creator  1.79.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2022
AC.ActionParamSet Class Reference
Inheritance diagram for AC.ActionParamSet:
AC.Action AC.IItemReferencerAction AC.IDocumentReferencerAction AC.iActionListAssetReferencer AC.IVariableReferencerAction

Public Member Functions

override void AssignValues (List< ActionParameter > parameters)
 Overwrites any appropriate variables with values set using parameters, or from ConstantID numbers. More...
 
override float Run ()
 Runs the Action. More...
 
override void ShowGUI (List< ActionParameter > parameters)
 Shows the Action's GUI when its parent ActionList / ActionListAsset uses parameters. More...
 
override void AssignConstantIDs (bool saveScriptsToo, bool fromAssetFile)
 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...
 
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...
 
override int GetNumVariableReferences (VariableLocation location, int varID, List< ActionParameter > parameters, Variables _variables=null, int _variablesConstantID=0)
 Gets the number of references the Action makes to a variable More...
 
override int UpdateVariableReferences (VariableLocation location, int oldVarID, int newVarID, List< ActionParameter > parameters, Variables _variables=null, int _variablesConstantID=0)
 Updated references the Action makes to a variable More...
 
int GetNumItemReferences (int _itemID, List< ActionParameter > parameters)
 
int UpdateItemReferences (int oldItemID, int newItemID, List< ActionParameter > parameters)
 
int GetNumDocumentReferences (int _docID, List< ActionParameter > parameters)
 
int UpdateDocumentReferences (int oldDocumentID, int newDocumentID, List< ActionParameter > parameters)
 
override bool ReferencesObjectOrID (GameObject _gameObject, int id)
 Checks if the Action makes reference to a particular GameObject More...
 
override bool ReferencesAsset (ActionListAsset _actionListAsset)
 
- Public Member Functions inherited from AC.Action
 Action ()
 
virtual void Upgrade ()
 
virtual void Skip ()
 
virtual int GetNextOutputIndex ()
 Gets the index of the output socket to use after the Action has run. More...
 
void PrintComment (ActionList actionList, ActionListAsset actionListAsset=null)
 Prints the Action's comment, if applicable, to the Console. More...
 
void SetOutputs (ActionEnd[] actionEnds)
 Update the Action's output sockets More...
 
void ResetSearchData ()
 
virtual void ShowGUI ()
 
void SkipActionGUI (List< Action > actions, bool showGUI)
 
void DrawOutWires (List< Action > actions, int i, int offset, Vector2 scrollPosition)
 
int FieldToID< T > (T field, int _constantID, bool alwaysAssign=false)
 
int FieldToID (Collider field, int _constantID)
 
void AddSaveScript< T > (Behaviour field)
 
void AddSaveScript< T > (GameObject _gameObject)
 
IDToField< T > (T field, int _constantID, bool moreInfo)
 
Collider IDToField (Collider field, int _constantID, bool moreInfo)
 
int FieldToID (Transform field, int _constantID, bool alwaysAssign=false)
 
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 List< ActionListAssetGetReferencedActionListAssets ()
 
virtual bool ReferencesPlayer (int playerID=-1)
 Checks if the Action makes reference to a particular ActionList asset More...
 
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 ()
 
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...
 
Object AssignObject< T > (List< ActionParameter > parameters, int _parameterID, Object field)
 Replaces a GameObject based on an ActionParameter or ConstantID instance, if appropriate. More...
 
AssignFile< T > (List< ActionParameter > parameters, int _parameterID, int _constantID, T field, bool doLog=true)
 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...
 
void FixLinkAfterDeleting (Action actionToDelete, Action targetAction, List< Action > actionList)
 
virtual void ClearIDs ()
 
virtual void SetLastResult (int _lastRunOutput)
 Updates which output was followed when the Action was last run More...
 
void ResetLastResult ()
 
virtual void ResetAssetValues ()
 
void SetOutput (ActionEnd actionEnd)
 Update the Action's output socket More...
 

Static Public Member Functions

static ActionParamSet CreateNew (int parameterID, bool newBoolValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change the a Bool parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, bool newBoolValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Bool parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, bool newBoolValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Bool parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, int newIntegerValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change an Integer parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, int newIntegerValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Bool parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, int newIntegerValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change the an Integer parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, float newFloatValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Float parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, float newFloatValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Float parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, float newFloatValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Float parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, string newStringValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a String parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, string newStringValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a String parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, string newStringValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a String parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, Vector3 newVectorValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Vector2 parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, Vector3 newVectorValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Vector3 parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, Vector3 newVectorValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Vector3 parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, Variables variables, int newComponentVariableIDValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Variable parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, Variables variables, int newComponentVariableIDValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Variable parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, Variables variables, int newComponentVariableIDValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Variable parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, GameObject newGameObjectValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a GameObject parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, GameObject newGameObjectValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a GameObject parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, GameObject newGameObjectValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a GameObject parameter on another ActionList More...
 
static ActionParamSet CreateNew (int parameterID, Object newObjectValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a UnityObject parameter on its own ActionList More...
 
static ActionParamSet CreateNew (ActionList actionList, int parameterID, Object newObjectValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a UnityObject parameter on another ActionList More...
 
static ActionParamSet CreateNew (ActionListAsset actionListAsset, int parameterID, Object newObjectValue)
 Creates a new instance of the 'ActionList: Set parameter' Action, set to change a UnityObject parameter on another ActionList More...
 
- 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="", bool alwaysShow=false)
 
static int ChooseParameterGUI (string label, List< ActionParameter > _parameters, int _parameterID, ParameterType[] _expectedTypes, 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)
 
static ActionEnd GenerateStopActionEnd ()
 
static T CreateNew< T > ()
 
static Action CreateNew (string className)
 
static void EditSource (Action _action)
 

Public Attributes

ActionListSource actionListSource = ActionListSource.InScene
 
ActionList actionList
 
int actionListConstantID
 
ActionListAsset actionListAsset
 
bool changeOwn
 
int parameterID = -1
 
int parameterToCopyID = -1
 
int intValue
 
float floatValue
 
string stringValue
 
GameObject gameobjectValue
 
int gameObjectConstantID
 
Object unityObjectValue
 
Vector3 vector3Value
 
SetParamMethod setParamMethod = SetParamMethod.EnteredHere
 
int globalVariableID
 
int globalVariableParameterID = -1
 
int ownParamID = -1
 
Variables variables
 
Animator animator
 
int animatorConstantID
 
int animatorParameterID = -1
 
string animatorParameterName
 
- Public Attributes inherited from AC.Action
int id
 
bool isDisplayed
 
bool showComment
 
string comment
 
bool willWait
 
bool isRunning
 
List< ActionEndendings = new List<ActionEnd> ()
 
bool isEnabled = true
 
bool isAssetFile = false
 
bool isMarked = false
 
bool isBreakPoint = false
 
Color overrideColor = Color.white
 
bool showOutputSockets = true
 
ActionList parentActionListInEditor = null
 

Protected Attributes

GameObject runtimeGameobjectValue
 
Variables runtimeVariables
 
ActionParameter _parameter
 
ActionParameter _parameterToCopy
 
Animator runtimeAnimator
 
- Protected Attributes inherited from AC.Action
ActionCategory category = ActionCategory.Custom
 
string title = "Untitled"
 
string description
 

Properties

override ActionCategory Category [get]
 
override string Title [get]
 
override string Description [get]
 
- Properties inherited from AC.Action
string searchData [get, protected set]
 
virtual ActionCategory Category [get]
 
virtual string Title [get]
 
virtual string Description [get]
 
virtual int NumSockets [get]
 
virtual bool RunNormallyWhenSkip [get]
 
virtual bool RunAllOutputs [get]
 
float defaultPauseTime [get]
 
int LastRunOutput [get]
 
Rect NodeRect [get, set]
 

Additional Inherited Members

- Static Public Attributes inherited from AC.Action
const int skipSocketSeparation = 48
 
const int socketSeparation = 28
 
- Protected Member Functions inherited from AC.Action
void AddSearchTerm (string term)
 
string TextArea (string text)
 
string TextField (string label, string text)
 
string DelayedTextField (string label, string text)
 
void AfterRunningOption ()
 
void SkipActionGUI (ActionEnd ending, List< Action > actions, bool showGUI)
 
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)
 
int ChoosePlayerGUI (int _playerID, bool includeActiveOption=false)
 
void TryAssignConstantID (Component component, ref int _constantID)
 
void TryAssignConstantID (GameObject gameObject, ref int _constantID)
 
Player AssignPlayer (int _playerID, List< ActionParameter > parameters, int _playerParameterID)
 
void Log (string message, Object context=null)
 
void LogWarning (string message, Object context=null)
 
void LogError (string message, Object context=null)
 
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...
 
GameObject AssignFile (int _constantID, GameObject field)
 Replaces a GameObject based on a ConstantID, if appropriate. More...
 
virtual string GetSocketLabel (int i)
 
ActionEnd GenerateActionEnd (ResultAction _resultAction, ActionListAsset _linkedAsset, Cutscene _linkedCutscene, int _skipAction, Action _skipActionActual, List< Action > _actions)
 

Member Function Documentation

◆ AssignConstantIDs()

override void AC.ActionParamSet.AssignConstantIDs ( bool  saveScriptsToo,
bool  fromAssetFile 
)
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.
fromAssetFileIf True, then the Action is placed in an ActionListAsset file

Reimplemented from AC.Action.

◆ AssignValues()

override void AC.ActionParamSet.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 from AC.Action.

◆ CreateNew() [1/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
bool  newBoolValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Bool parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Bool parameter
newBoolValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [2/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
float  newFloatValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Float parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Float parameter
newFloatValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [3/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
GameObject  newGameObjectValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a GameObject parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the GameObject parameter
newGameObjectValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [4/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
int  newIntegerValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Bool parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Bool parameter
newBoolValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [5/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
Object  newObjectValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a UnityObject parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the UnityObject parameter
newObjectValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [6/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
string  newStringValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a String parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the String parameter
newStringValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [7/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
Variables  variables,
int  newComponentVariableIDValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Variable parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Component Variable parameter
variablesThe new parameter's new Variables component
newComponentVariableIDValueThe parameter's new variable ID number
Returns
The generated Action

◆ CreateNew() [8/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionList  actionList,
int  parameterID,
Vector3  newVectorValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Vector3 parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Vector3 parameter
newVectorValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [9/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
bool  newBoolValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Bool parameter on another ActionList

Parameters
actionListAssetThe ActionList asset with the parameter
parameterIDThe ID number of the Bool parameter
newBoolValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [10/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
float  newFloatValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Float parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the Float parameter
newFloatValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [11/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
GameObject  newGameObjectValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a GameObject parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the GameObject parameter
newGameObjectValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [12/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
int  newIntegerValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change the an Integer parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the Integer parameter
newIntegerValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [13/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
Object  newObjectValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a UnityObject parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the UnityObject parameter
newObjectValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [14/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
string  newStringValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a String parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the String parameter
newStringValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [15/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
Variables  variables,
int  newComponentVariableIDValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Variable parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the Component Variable parameter
variablesThe new parameter's new Variables component
newComponentVariableIDValueThe parameter's new variable ID number
Returns
The generated Action

◆ CreateNew() [16/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( ActionListAsset  actionListAsset,
int  parameterID,
Vector3  newVectorValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Vector3 parameter on another ActionList

Parameters
actionListAssetThe ActionList with the parameter
parameterIDThe ID number of the Vector3 parameter
newVectorValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [17/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
bool  newBoolValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change the a Bool parameter on its own ActionList

Parameters
parameterIDThe ID number of the Bool parameter
newBoolValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [18/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
float  newFloatValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Float parameter on its own ActionList

Parameters
parameterIDThe ID number of the Float parameter
newFloatValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [19/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
GameObject  newGameObjectValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a GameObject parameter on its own ActionList

Parameters
parameterIDThe ID number of the GameObject parameter
newGameObjectValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [20/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
int  newIntegerValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change an Integer parameter on another ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Integer parameter
newIntegerValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [21/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
Object  newObjectValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a UnityObject parameter on its own ActionList

Parameters
parameterIDThe ID number of the UnityObject parameter
newObjectValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [22/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
string  newStringValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a String parameter on its own ActionList

Parameters
parameterIDThe ID number of the String parameter
newStringValueThe parameter's new value
Returns
The generated Action

◆ CreateNew() [23/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
Variables  variables,
int  newComponentVariableIDValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Variable parameter on its own ActionList

Parameters
parameterIDThe ID number of the Component Variable parameter
variablesThe new parameter's new Variables component
newComponentVariableIDValueThe parameter's new variable ID number
Returns
The generated Action

◆ CreateNew() [24/24]

static ActionParamSet AC.ActionParamSet.CreateNew ( int  parameterID,
Vector3  newVectorValue 
)
static

Creates a new instance of the 'ActionList: Set parameter' Action, set to change a Vector2 parameter on its own ActionList

Parameters
actionListThe ActionList with the parameter
parameterIDThe ID number of the Vector3 parameter
newVectorValueThe parameter's new value
Returns
The generated Action

◆ GetNumVariableReferences()

override int AC.ActionParamSet.GetNumVariableReferences ( VariableLocation  location,
int  varID,
List< ActionParameter parameters,
Variables  variables = null,
int  variablesConstantID = 0 
)
virtual

Gets the number of references the Action makes to a variable

Parameters
locationThe variable's location (Global, Local)
varIDThe variable's ID number
parametersThe List of ActionParameters associated with the ActionList that contains the Action
variablesThe Variables component, if location = VariableLocation.Component
Returns
The number of references the Action makes to the variable

Reimplemented from AC.Action.

◆ ReferencesObjectOrID()

override bool AC.ActionParamSet.ReferencesObjectOrID ( GameObject  gameObject,
int  id 
)
virtual

Checks if the Action makes reference to a particular GameObject

Parameters
gameObjectThe GameObject to check for
idThe GameObject's associated ConstantID value
Returns
True if the Action references the GameObject

Reimplemented from AC.Action.

◆ Run()

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

◆ UpdateVariableReferences()

override int AC.ActionParamSet.UpdateVariableReferences ( VariableLocation  location,
int  oldVarID,
int  newVarID,
List< ActionParameter parameters,
Variables  variables = null,
int  variablesConstantID = 0 
)
virtual

Updated references the Action makes to a variable

Parameters
locationThe variable's location (Global, Local)
oldVarIDThe variable's original ID number
newVarIDThe variable's new ID number
parametersThe List of ActionParameters associated with the ActionList that contains the Action
variablesThe Variables component, if location = VariableLocation.Component
Returns
The number of references the Action makes to the variable

Reimplemented from AC.Action.