 |
AiMalgam Core 1.1.0
API documentation for the generic Unity3D AI System
|
|
AiMalgam Core 1.1.0
API documentation for the generic Unity3D AI System
|
To be able to inject the AiMalgamBaseSettings into the correct AiMalgamBaseEngineWrapper we need to specify the correct AiMalgamBaseAction<BlackboardType> as well. This can be achieved by inheriting this wrapper/ helper class. More...
Additional Inherited Members | |
 Public Member Functions inherited from NikosAssets.AiMalgam.Settings.Actions.AiMalgamBaseSettings | |
| override string | ToString () |
| Public Member Functions inherited from NikosAssets.AiMalgam.Settings.AiMalgamNode | |
| override void | OnOpen () |
| Called if the AiMalgamNodeGraph hosting this Node is opened | |
| virtual void | NotifyOnNodeChanged () |
| A helper method to notify node value changes and emit the OnNodeChanged event | |
| override object | GetValue (NodePort port) |
| Used in the AiMalgamNodeGraph. More... | |
| virtual void | ResetMarkingInGraph (AiMalgamEntity requester, bool forceRepaint=false) |
| EDITOR ONLY EFFECT. Reset the node's visuals in the AiMalgamNodeGraph More... | |
| virtual void | MarkInGraph (AiMalgamEntity requester, bool acceptedOrFailed, bool forceRepaint=false) |
| EDITOR ONLY EFFECT. Set the node's visuals in the AiMalgamNodeGraph (accepted or failed) More... | |
| virtual void | MarkInGraph (AiMalgamEntity requester, Color markColor, bool forceRepaint=false) |
| EDITOR ONLY EFFECT. Set the node's visuals in the AiMalgamNodeGraph More... | |
| Public Attributes inherited from NikosAssets.AiMalgam.Settings.Actions.AiMalgamBaseSettings | |
| AiMalgamBaseSettings | output |
| Used in the AiMalgamNodeGraph. Do not temper with it! | |
| AiMalgamBaseCondition | conditionToEnter |
| The AiMalgamBaseCondition of this AiMalgamBaseSettings to enter its AiMalgamBaseEngineWrapper | |
| AiMalgamBaseCondition | conditionToValidate |
| The AiMalgamBaseCondition of this Setting to validate | |
| bool | repeatExecution = true |
| Repeat the execution of this Setting forever | |
| int | repeatExecutionAmount = 0 |
| Repeat the execution of this Setting for an - additional! - specific amount (inclusive) | |
| TimingHelper | executionTiming = new TimingHelper(TimingHelper.TimerType.Instant) |
| Delay (each) AiMalgamBaseAction<BlackboardType> execution of this Setting by... | |
| int | maxStackable = 1 |
| The maximum (inclusive) allowed stacking of this Setting in one and the same AiMalgamBaseEngineWrapper | |
| bool | succeedOnStackLimitReached = true |
| If the Setting cannot be applied due to the max stacking limit reached, should it count as a success or failure? | |
| int | priority = 0 |
| Represents the order of execution of this Settings AiMalgamBaseAction<BlackboardType> in its hosting AiMalgamBaseEngineWrapper | |
| bool | restoreValuesOnDispose |
| If Components or other ScriptableObjects were changed after the AiMalgamBaseAction<BlackboardType> of this Setting completed, restore said components and scriptable objects to their previous values | |
| bool | disposeOnValidationFail |
| Stop the executing AiMalgamBaseAction<BlackboardType>(s), if its validation fails | |
| int | maxAllowedFailedValidations = 0 |
| The maximum (inclusive) allowed validation fails, before the AiMalgamBaseAction<BlackboardType> of this Setting gets disposed | |
| AiMalgamBaseCondition | conditionToDispose |
| The AiMalgamBaseCondition container to dispose the running AiMalgamBaseAction<BlackboardType> | |
| TimingHelper | disposalTiming = new TimingHelper(TimingHelper.TimerType.Never) |
| More advanced Settings that rule over the disposal of AiMalgamBaseAction<BlackboardType>s running this Setting | |
| AiMalgamState | representsState |
| The (optional) AiMalgamState this Setting represents | |
| bool | exitStateOnDispose = true |
| Should the AiMalgamEntity exit the represented AiMalgamState of this Setting after it has been disposed by its hosting AiMalgamBaseAction<BlackboardType>? | |
| bool | disposeAllActiveStatesAndActionsOnEnterSuccess = false |
| Exits all other active AiMalgamStates and disposes all other active AiMalgamBaseAction<BlackboardType>s running on the AiMalgamEntity, if this Setting successfully enters its designated AiMalgamBaseEngineWrapper | |
| AiMalgamStatesListWrapper | disposeStatesAndActions = new AiMalgamStatesListWrapper() |
| Disposes specific listed AiMalgamStates and AiMalgamBaseAction<BlackboardType>s on the target AiMalgamEntity and AiMalgamBaseEngineWrapper | |
| AiMalgamStatesListWrapper | isBlockedByStates = new AiMalgamStatesListWrapper() |
| This Setting is blocked by the following listed AiMalgamStates | |
| bool | ignoreIsBlockedByOnEnter |
| Ignore the listed blocked by AiMalgamStates while entering the designated AiMalgamBaseEngineWrapper | |
| bool | ignoreIncomingBlockingStatesWhileActive |
| Ignore any incoming AiMalgamBaseAction<BlackboardType>s and AiMalgamStates, that are listed in the isBlockedByStates list, while this Settings AiMalgamBaseAction<BlackboardType> is active | |
| Protected Member Functions inherited from NikosAssets.AiMalgam.Settings.Actions.AiMalgamBaseSettings | |
| override void | Reset () |
| override void | Awake () |
| virtual void | UpdateSupportedActionType () |
| override void | OnValidate () |
| Protected Member Functions inherited from NikosAssets.AiMalgam.Settings.AiMalgamNode | |
| override void | Reset () |
| override void | OnEnable () |
| override void | Awake () |
| override void | OnValidate () |
| Protected Attributes inherited from NikosAssets.AiMalgam.Settings.Actions.AiMalgamBaseSettings | |
| string | _actionTypeSupported = "" |
| Used to find the matching AiMalgamBaseAction<BlackboardType> and AiMalgamBaseEngineWrapper for this (specific and inherited) Setting by generating a hash (ActionTypeSupportedHash) | |
| int | _actionTypeSupportedHash = -1 |
| Used to find the matching AiMalgamBaseAction<BlackboardType> and AiMalgamBaseEngineWrapper for this (specific and inherited) Setting | |
| Properties inherited from NikosAssets.AiMalgam.Settings.Actions.AiMalgamBaseSettings | |
| string | ActionTypeSupported [get, protected set] |
| Used to find the matching AiMalgamBaseAction<BlackboardType> and AiMalgamBaseEngineWrapper for this (specific and inherited) Setting by generating a hash (ActionTypeSupportedHash) Updating this property, generates the ActionTypeSupportedHash automatically | |
| int | ActionTypeSupportedHash [get] |
| Used to find the matching AiMalgamBaseAction<BlackboardType> and AiMalgamBaseEngineWrapper for this (specific and inherited) Setting | |
| Events inherited from NikosAssets.AiMalgam.Settings.AiMalgamNode | |
| virtual Action< AiMalgamNode > | OnNodeChanged |
| Emitted, if the node values where changed (OnValidate()) | |
To be able to inject the AiMalgamBaseSettings into the correct AiMalgamBaseEngineWrapper we need to specify the correct AiMalgamBaseAction<BlackboardType> as well. This can be achieved by inheriting this wrapper/ helper class.
| ActionType | The ActionType that must inherit from AiMalgamBaseAction<BlackboardType> |
| BlackboardType | The BlackboardType the AiMalgamBaseAction<BlackboardType> depends on |
| BlackboardType | : | IAiMalgamBlackboard | |
| ActionType | : | AiMalgamBaseAction<BlackboardType> |
1.9.3