Get whether the AI is in a forced home state||doc135588

September 20, 2022

Format

 AIControl:isInForceGoHomeState()
  • The class to which the function belongs:AIControl

Description

Get whether the AI is currently forced to go home.


Value Returned

type Description
bool true, force home state. false, other states

Code Samples

on the entity object servermount script, to get whether the AI is currently in the state of being forced to go home

local control = this:getAIControl()
local isForceGoingHome = control:isInForceGoHomeState()