AI Lua API: Difference between revisions
No edit summary |
No edit summary |
||
| Line 47: | Line 47: | ||
| state || string | | state || string | ||
|- | |- | ||
| value || | | value || Lua Type | ||
|} | |} | ||
'''Description''': Change the World State of an NPC. | '''Description''': Change the World State of an NPC. | ||
| Line 66: | Line 66: | ||
| permanent || bool | | permanent || bool | ||
|} | |} | ||
'''Description''': Reduce the cost of an AI using a particular | '''Description''': Reduce the cost of an AI using a particular Interest | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
| Line 84: | Line 84: | ||
| permanent || bool | | permanent || bool | ||
|} | |} | ||
'''Description''': Increase the cost of an AI using a particular | '''Description''': Increase the cost of an AI using a particular Interest | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
'''Notes''': If permanent is false, the cost will revert to normal the next time this is successfully used | '''Notes''': If permanent is false, the cost will revert to normal the next time this is successfully used | ||
=== ChangeSubject === | |||
<syntaxhighlight source lang="lua">AI.ChangeSubject(characterName, subject, value)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| characterName || string | |||
|- | |||
| subject || string | |||
|- | |||
| value || string | |||
|} | |||
'''Description''': Set the value of a particular subject, enabling Actions with Personality requirements | |||
'''Returns''': Nothing | |||
'''Notes''': value can be null or empty (to unset/reset the subject) | |||
=== ReactTo === | |||
<syntaxhighlight source lang="lua">AI.ReactTo(characterName, subject, value)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| characterName || string | |||
|- | |||
| subject || string | |||
|- | |||
| value || string | |||
|} | |||
'''Description''': Much like ChangeSubject, but instead of enabling Actions, this will alter stats within the Agent, modifying its WorldState (and as a result, enabling Actions) | |||
'''Returns''': Nothing | |||
'''Notes''': value can be null or empty (to unset/reset the subject) | |||
=== CreateReactable === | === CreateReactable === | ||
<syntaxhighlight source lang="lua">AI.CreateReactable(actionType, attraction, targetObject)</syntaxhighlight> | <syntaxhighlight source lang="lua">AI.CreateReactable(actionType, attraction, targetObject)</syntaxhighlight> | ||
| Line 125: | Line 161: | ||
This file is auto generated, please don't edit manually! | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': | '''Docs last hacked together on''': 08/03/2019 13:51 | ||
[[Category:Modding]][[Category:LuaAPI]] | [[Category:Modding]][[Category:LuaAPI]] | ||
Revision as of 13:52, 8 March 2019
AI
Description
API to control the logic of AI in the mission
Functions
AddTemporaryGoal
AI.AddTemporaryGoal(characterName, goal)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| goal | Lua Table |
Description: Adds a goal, taking top priority, to the named AI
Returns: Nothing
Notes: This goal will be removed from the AI once complete. If it isn't achievable it will be removed immediately.
AlterNPCMotivation
AI.AlterNPCMotivation(characterName, motivationDelta)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| motivationDelta | number |
Description: Alters an NPCS motivation state
Returns: Nothing
Notes: When an NPCs motivation hits 0, they're no longer motivated and will attempt to take a break
AlterNPCWorldState
AI.AlterNPCWorldState(characterName, state, value)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| state | string |
| value | Lua Type |
Description: Change the World State of an NPC.
Returns: Nothing
FavourInterest
AI.FavourInterest(characterName, device, permanent)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| device | string |
| permanent | bool |
Description: Reduce the cost of an AI using a particular Interest
Returns: Nothing
Notes: If permanent is false, the cost will revert to normal the next time this is successfully used
AvoidInterest
AI.AvoidInterest(characterName, device, permanent)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| device | string |
| permanent | bool |
Description: Increase the cost of an AI using a particular Interest
Returns: Nothing
Notes: If permanent is false, the cost will revert to normal the next time this is successfully used
ChangeSubject
AI.ChangeSubject(characterName, subject, value)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| subject | string |
| value | string |
Description: Set the value of a particular subject, enabling Actions with Personality requirements
Returns: Nothing
Notes: value can be null or empty (to unset/reset the subject)
ReactTo
AI.ReactTo(characterName, subject, value)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| subject | string |
| value | string |
Description: Much like ChangeSubject, but instead of enabling Actions, this will alter stats within the Agent, modifying its WorldState (and as a result, enabling Actions)
Returns: Nothing
Notes: value can be null or empty (to unset/reset the subject)
CreateReactable
AI.CreateReactable(actionType, attraction, targetObject)
Expected parameter types
| Name | Type |
|---|---|
| actionType | AIReaction+Type |
| attraction | number |
| targetObject | MissionObject |
Description: Create a new distraction that AI can pick up on
Returns: Nothing
SetNPCFavouredComputer
AI.SetNPCFavouredComputer(characterName, computer)
Expected parameter types
| Name | Type |
|---|---|
| characterName | string |
| computer | MissionObject |
Description: Set NPC's computer, this will be used for a variety of actions
Returns: Nothing
This file is auto generated, please don't edit manually!
Docs last hacked together on: 08/03/2019 13:51