AI Lua API: Difference between revisions
No edit summary |
No edit summary |
||
Line 53: | Line 53: | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
=== FavourInterest === | |||
<syntaxhighlight source lang="lua">AI.FavourInterest(characterName, device, permanent)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| characterName || string | |||
|- | |||
| device || string | |||
|- | |||
| permanent || bool | |||
|} | |||
'''Description''': Reduce the cost of an AI using a particular Device | |||
'''Returns''': Nothing | |||
'''Notes''': If permanent is false, the cost will revert to normal the next time this is successfully used | |||
=== AvoidInterest === | |||
<syntaxhighlight source lang="lua">AI.AvoidInterest(characterName, device, permanent)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| characterName || string | |||
|- | |||
| device || string | |||
|- | |||
| permanent || bool | |||
|} | |||
'''Description''': Increase the cost of an AI using a particular Device | |||
'''Returns''': Nothing | |||
'''Notes''': If permanent is false, the cost will revert to normal the next time this is successfully used | |||
=== CreateReactable === | === CreateReactable === | ||
<syntaxhighlight source lang="lua">AI.CreateReactable(actionType, attraction, targetObject)</syntaxhighlight> | <syntaxhighlight source lang="lua">AI.CreateReactable(actionType, attraction, targetObject)</syntaxhighlight> | ||
Line 89: | Line 125: | ||
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''': 11 | '''Docs last hacked together on''': 02/11/2018 12:59 | ||
[[Category:Modding]][[Category:LuaAPI]] | [[Category:Modding]][[Category:LuaAPI]] |
Revision as of 13:00, 2 November 2018
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 | bool |
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 Device
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 Device
Returns: Nothing
Notes: If permanent is false, the cost will revert to normal the next time this is successfully used
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: 02/11/2018 12:59