AI Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<!-- This file is auto generated, please don't edit manually! -->
<!-- This file is auto generated, please don't edit manually! -->
= AI Gestures =
= AI =
== Description ==
== Description ==
The enums on this page can be used by AI agent definitions to play an animation when an action is taken. These enums map directly on to states in the character animator, which is shared by all characters. Make sure you type the name exactly as it appears here, it's case sensitive.
API to control the logic of AI in the mission
== Fields ==
== Functions ==
=== LookAround ===
=== Pause ===
Looks from side to side.
<syntaxhighlight source lang="lua">AI.Pause(characterName)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|}
'''Description''': Pauses the agent, and stops it from doing anything.


=== LookAtPhone ===
'''Returns''': Nothing
Retrieves phone from pocket, has a look at it, then puts it away.


=== StandingTypingCalm ===
'''Notes''': The AI will be hidden from networks, meaning it will no longer interact with devices or send/receive messages.
Typing from a standing position, in a fairly normal manner.
=== Unpause ===
<syntaxhighlight source lang="lua">AI.Unpause(characterName)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|}
'''Description''': Unpauses a hidden agent, resuming standard behaviour.


=== StandingTypingStealth ===
'''Returns''': Nothing
Typing from a standing position, in a sneaky manner.


=== StandingFilingCabinetSearch ===
=== IsPaused ===
Searches a filing cabinet.
<syntaxhighlight source lang="lua">AI.IsPaused(characterName)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|}
'''Description''': Returns a bool based on if a character is currently paused or not


=== StandingLookAtHipHeight ===
'''Returns''': bool
Not sure.


=== StandingAmokDeviceHit ===
=== AddGoal ===
Hits a device that's in front of the character.
<syntaxhighlight source lang="lua">AI.AddGoal(characterName, goal)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| goal || Lua Table
|}
'''Description''': Adds a defined goal


=== UseSodaMachine ===
'''Returns''': Nothing
Press button, retrieve soda, drink it, discard can.


=== UseSodaMachineHacked ===
=== RemoveGoal ===
Press button, get hit by can, keel over.
<syntaxhighlight source lang="lua">AI.RemoveGoal(characterName, goalName)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| goalName || string
|}
'''Description''': Removes any defined goals


=== UseCoffeeMachine ===
'''Returns''': Nothing
Press button, retrieve coffee cup, drink.


=== UseCoffeeMachineHacked ===
=== AddTemporaryGoal ===
Press button, get hit by steam, panic and writhe in pain.
<syntaxhighlight source lang="lua">AI.AddTemporaryGoal(characterName, goal)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| goal || Lua Table
|}
'''Description''': Adds a goal, taking top priority, to the named AI


=== DanceHipHop ===
'''Returns''': Nothing
Hip hop dancing.


=== DanceGuitar ===
'''Notes''': This goal will be removed from the AI once complete. If it isn't achievable it will be removed immediately.
Air guitar!
=== AlterNPCMotivation ===
<syntaxhighlight source lang="lua">AI.AlterNPCMotivation(characterName, motivationDelta)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| motivationDelta || number
|}
'''Description''': Alters an NPCS motivation state


=== DanceSalsa ===
'''Returns''': Nothing
Strictly come Off Grid.


=== Yawn ===
'''Notes''': When an NPCs motivation hits 0, they're no longer motivated and will attempt to take a break
Yawn, with arms outstretched.
=== AlterNPCWorldState ===
<syntaxhighlight source lang="lua">AI.AlterNPCWorldState(characterName, state, value)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| state || string
|-
| value || Lua Type
|}
'''Description''': Change the World State of an NPC.


=== StandingTalkingCalmly ===
'''Returns''': Nothing
Standing talking calmly with hands near waist.


=== StandingTalkingAngrily ===
=== FavourInterest ===
Standing talking angrily with hand gestures.
<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 Interest


=== StandingUseTazer ===
'''Returns''': Nothing
Standing raises right arm in front.


=== StandingPhoneMalfunctioning ===
'''Notes''': If permanent is false, the cost will revert to normal the next time this is successfully used
Gets phone out, swipes frantically, puts phone away and looks around.
=== 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 Interest


=== StandingLookingHunched ===
'''Returns''': Nothing
Standing, almost crouches down and peers around.


=== StandingLookingSideToSide ===
'''Notes''': If permanent is false, the cost will revert to normal the next time this is successfully used
Standing, looks side to side.
=== 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


=== StandingHitFace ===
'''Returns''': Nothing
Standing, quickly brings hands to face.


=== PickupLow ===
'''Notes''': value can be null or empty (to unset/reset the subject)
Standing pick up from ankle hight.
=== 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)


=== PickupMed ===
'''Returns''': Nothing
Standing pick up from waist hight.


=== PickupHigh ===
'''Notes''': value can be null or empty (to unset/reset the subject)
Standing pick up from head hight.
=== CreateReactable ===
<syntaxhighlight source lang="lua">AI.CreateReactable(actionType, attraction, targetObject)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| actionType || AIReaction+Type
|-
| attraction || number
|-
| targetObject || MissionObject
|}
'''Description''': Create a new distraction that AI can pick up on


=== LockedDoor ===
'''Returns''': Nothing
Standing, puts hand on handle, struggles.


=== WashingDryingHands ===
=== SetNPCFavouredComputer ===
Standing, hands out in front rubbing together.
<syntaxhighlight source lang="lua">AI.SetNPCFavouredComputer(characterName, computer)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| computer || MissionObject
|}
'''Description''': Set NPC's computer, this will be used for a variety of actions


=== WaitingHandsOnHips ===
'''Returns''': Nothing
Standing with hands on hips.


=== WashFace ===
=== AddAction ===
Standing washing face.
<syntaxhighlight source lang="lua">AI.AddAction(characterName, action)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| action || Lua Table
|}
'''Description''': Adds an action that can be used immediately


=== UseSnackMachine ===
'''Returns''': Nothing


=== RemoveAction ===
<syntaxhighlight source lang="lua">AI.RemoveAction(characterName, actionName)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| characterName || string
|-
| actionName || string
|}
'''Description''': Removes any action


=== UseSnackMachineHacked ===
'''Returns''': Nothing
 




Line 101: Line 261:
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''': 23/07/2020 11:58
'''Docs last hacked together on''': 28/10/2020 18:12
[[Category:Modding]][[Category:LuaAPI]]
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 18:13, 28 October 2020

AI

Description

API to control the logic of AI in the mission

Functions

Pause

AI.Pause(characterName)

Expected parameter types

Name Type
characterName string

Description: Pauses the agent, and stops it from doing anything.

Returns: Nothing

Notes: The AI will be hidden from networks, meaning it will no longer interact with devices or send/receive messages.

Unpause

AI.Unpause(characterName)

Expected parameter types

Name Type
characterName string

Description: Unpauses a hidden agent, resuming standard behaviour.

Returns: Nothing

IsPaused

AI.IsPaused(characterName)

Expected parameter types

Name Type
characterName string

Description: Returns a bool based on if a character is currently paused or not

Returns: bool

AddGoal

AI.AddGoal(characterName, goal)

Expected parameter types

Name Type
characterName string
goal Lua Table

Description: Adds a defined goal

Returns: Nothing

RemoveGoal

AI.RemoveGoal(characterName, goalName)

Expected parameter types

Name Type
characterName string
goalName string

Description: Removes any defined goals

Returns: Nothing

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

AddAction

AI.AddAction(characterName, action)

Expected parameter types

Name Type
characterName string
action Lua Table

Description: Adds an action that can be used immediately

Returns: Nothing

RemoveAction

AI.RemoveAction(characterName, actionName)

Expected parameter types

Name Type
characterName string
actionName string

Description: Removes any action

Returns: Nothing


This file is auto generated, please don't edit manually!

Docs last hacked together on: 28/10/2020 18:12

Retrieved from "http://wiki.offgridthegame.com/index.php?title=AI_Lua_API&oldid=1553"