🗃️NACT

CharacterCleanup

undefined

function NACT.CharacterCleanup(character: any)

Parameters

Name	Type	Description
character	any

Constructor

undefined

(method) NACT:Constructor()

Parameters

DebugDisplayCoverPoints

INTERNAL. Used by the editor mode. This will create a trigger for each cover point. Usage in production not good.

function NACT.DebugDisplayCoverPoints()

Parameters

GetCharacterFromCauserEntity

Get the character from the causer in some events of nanos

function NACT.GetCharacterFromCauserEntity(causer: Character|Weapon)
  -> Character

Returns

Character the real causer

Parameters

Name	Type	Description
causer	Character	Weapon

GetMapCoverPoints

Returns all the defined cover points of the territory

function NACT.GetMapCoverPoints()
  -> table

Returns

table TO BE DOCUMENTED

Parameters

GetTime

Get time in seconds

function NACT.GetTime()
  -> number

Returns

number The time in seconds

Parameters

GetTriggerPopulation

Gets the trigger population of the trigger in parameter

sPopulationType:
    | "enemies"
    | "allies"

function NACT.GetTriggerPopulation(tTrigger: table, sPopulationType: "allies"|"enemies")
  -> Array: table

Returns

table array of characters that populates the trigger

Parameters

Name	Type	Description
tTrigger	table	TriggerTable to scan
sPopulationType	"allies"	"enemies"

RegisterNpc

This functions handles registering a new NPC into the system. It will wrap a Character with a NACT_NPC.

NACT provies a few default configurations #LINK MISSING# for you to use, but it's funnier to tweak stuff!

It can take the following table as a configuration:

{
    -- List of all the behaviors. Pass it or use AddBehavior #LINK MISSING# or your NPC will be a static potato
    behaviors= {
      class = NACT_Idle,
    }, {
      class = NACT_Detection,
      config = {
          heatIncrement = 20
       }
    },

    -- Does the NPC has a human like vision (auto vision) or behaves like an animal/flesh ?
    -- Default to true
    autoVision = false,

    -- Vision "angle", the vision range... Huh kinda, I should make it better before alpha, it's simple to fix maybe I'll forgot let me know!
    -- Right now, 0 means 360° vision angle. Defaults to 110 (wich means 90 :D)
    visionAngle = 90,

    look
}

You can pass any additional value you want if you need them for your behaviors in the config part.

function NACT.RegisterNpc(cNpcToHandle: Character, sTerritoryName: string, tNpcConfig: table)
  -> NACT_NPC|nil

Returns

NACT_NPC|nil NACT_NPC created or nil if operation failed

Parameters

Name	Type	Description
cNpcToHandle	Character	Npc to be controlled NACT
sTerritoryName	string	The Territory this NPC will use to find it's cover and patrol points
tNpcConfig	table	See above for tNpcConfig map

RegisterTerritory

Add a territory to NACT.

It can take the following table as a configuration:

{
    -- The team number of the territory. Based on [NanosWorld team system](https://docs.nanos.world/docs/scripting-reference/classes/character#function-setteam)
    team = 1,

    -- Bounds of the territory, if provided. NACT_Idle behavior will wake up once an enemy enters the territory.
    zoneBounds = {
        pos = Vector(-20461.71, 4215.02, 198.15),
        radius = 7000
    },
    
    -- All the patrol routes used by NACT_Patrol behavior. You can also call the AddPatrol function
    patrolRoutes = {
        frontCamp = {
              points = {
                  Vector(-20417.73, 4071.38, 198.1),
                  Vector(-18437.47, 3902.86, 198.1),
                  Vector(-18685.67, 1708.65, 198.1),
                  Vector(-20263.24, 1713.28, 198.3)
              },
              walkMethod = "circle"
         },
    }
}

You can pass any additional value you want if you need them for your behaviors.

function NACT.RegisterTerritory(sTerritoryName: string, tZoneConfigTable: table)
  -> NACT_Territory

Returns

NACT_Territory The created territory

Parameters

Name	Type	Description
sTerritoryName	string	Name of the territory
tZoneConfigTable	table	Documented above

SetMapCoverPoints

Set the map cover points that will be used when creating a territory

function NACT.SetMapCoverPoints(tMapCoverPoints: table)

Parameters

Name	Type	Description
tMapCoverPoints	table	TO BE DOCUMENTED test doc update

ValueOrDefault

Utility function especially useful for configurations. Returns a value if defined or the default

function NACT.ValueOrDefault(maybeValue: any, default: any)
  -> maybeValue: any

Returns

any or defaultValue

Parameters

Name	Type	Description
maybeValue	any	The value to be used if not nil
default	any	The default value if maybeValue is nil

createTriggerBox

Creates a trigger box for NACT while keeping track of all the allies and enemies that enter or leave the trigger box

function NACT.createTriggerBox(vTriggerLocation: Vector, linkedTerritoryOrNpc: NACT_NPC|NACT_Territory, eTriggerType: TriggerType, nRadius: number, eDebugColor: Color, bServerTrigger: Boolean, checkEvery: Number)
  -> Trigger: table

Returns

table resulting table

Parameters

Name	Type	Description
vTriggerLocation	Vector	Location to spawn the trigger
linkedTerritoryOrNpc	NACT_NPC	NACT_Territory
eTriggerType	TriggerType	The trigger type to create
nRadius	number	Radius of the trigger
eDebugColor	Color	the debug color when debugging triggers
bServerTrigger	Boolean	either this trigger is serverside or clientside (CSSTT)
checkEvery	Number	Every ticks to check. 1 will check every tick, 20 will check every 20 ticks