Action¶
EEex_Action_AddEnabledSpriteStartedActionListener¶
Warning
This function is currently undocumented.
EEex_Action_AddSpriteStartedActionListener¶
Warning
This function is currently undocumented.
EEex_Action_AddSpriteStartedNextActionListener¶
Warning
This function is currently undocumented.
EEex_Action_ExecuteResponseStringOnAIBaseInstantly¶
Summary
Has pGameAIBase instantly execute the actions contained in responseStr
without interrupting pGameAIBase’s current action / readying pGameAIBase.
EEex_Action_ParseResponseString() is used to compile responseStr; prefer using this function
in conjunction with EEex_Action_ExecuteScriptFileResponseAsAIBaseInstantly() when efficiency is required.
Running this function with actions not defined in INSTANT.IDS is undefined behavior.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
responseStr |
string |
The string to parse. |
|
pGameAIBase |
CGameAIBase |
The AI base that will execute the actions. |
EEex_Action_ExecuteScriptFileResponseAsAIBaseInstantly¶
Instance Name: executeResponseAsAIBaseInstantly
Summary
Has pGameAIBase instantly execute compiled actions returned by EEex_Action_ParseResponseString()
without interrupting pGameAIBase’s current action / readying pGameAIBase.
Running this function with actions not defined in INSTANT.IDS is undefined behavior.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
pScriptFile |
CAIScriptFile |
The AI script file returned by |
|
pGameAIBase |
CGameAIBase |
The AI base that will execute the actions. |
EEex_Action_FreeScriptFile¶
Instance Name: free
Summary
Frees the value returned by EEex_Action_ParseResponseString().
Attempting to use pScriptFile after calling :free() will result in a crash.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
pScriptFile |
CAIScriptFile |
The AI script file to free. |
EEex_Action_LuaHook_OnAfterSpriteStartedAction¶
Warning
This function is currently undocumented.
EEex_Action_NextSpellToPoint¶
Warning
This function is currently undocumented.
EEex_Action_ParseResponseString¶
Summary
Parses responseStr as if it was fed through C:Eval() and
returns the compiled script object, (only filled with actions).
Remember to call :free() on the returned value when it is no longer being used.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
responseStr |
string |
The string to parse. |
Return Values:
Type |
Description |
|---|---|
CAIScriptFile |
See summary. |
EEex_Action_QueueResponseStringOnAIBase¶
Summary
Adds the actions contained in responseStr to the end of pGameAIBase’s action queue.
Behavior identical to C:Eval().
EEex_Action_ParseResponseString() is used to compile responseStr; prefer using this function
in conjunction with EEex_Action_QueueScriptFileResponseOnAIBase() when efficiency is required.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
responseStr |
string |
The string to parse. |
|
pGameAIBase |
CGameAIBase |
The AI base to queue the actions on. |
EEex_Action_QueueScriptFileResponseOnAIBase¶
Instance Name: queueResponseOnAIBase
Summary
Adds compiled actions returned by EEex_Action_ParseResponseString() to the end of pGameAIBase’s action queue.
Behavior identical to C:Eval().
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
pScriptFile |
CAIScriptFile |
The AI script file returned by |
|
pGameAIBase |
CGameAIBase |
The AI base to queue the actions on. |