ACS interface

The KAI library includes several functions that can be called from ACS for the purposes of either affecting KAI NPCs from map scripts, or using KAI_DataToken to read and write info for optional KAI support in non-KAI mods.

KAI_DataToken

These are direct ACS functions that can be used to access and write info to the KAI_DataToken item. Useful for allowing non-KAI mods to add optional KAI support without creating a hard dependency to the library anyway. If these functions are not called from a KAI_DataToken, they'll do nothing.

These functions can either be called from ACS like below:

(Placeholder, add ACS library example here)

Or called from ZScript (i.e for your non-KAI actor to mark itself as a threat) using ACS_ScriptCall() like this:

		String TokenString = "KAI_DataToken"; //The token might not exist because KAI is not loaded with my mod.
		Class<Inventory> Tok = TokenString;
		If (Tok)
		{
			Let Token = GiveInventoryType (Tok); //But it does, so give it to my NPC/
			
			If (Token)
				Token.ACS_ScriptCall("KAIToken_SetThreatLevel",6); //THREAT_ABOVENORMAL //And set his threat level from the token.
		}

ACS Functions/Scripts

KAI_Token_SetThreatLevel

Sets a threat level for the token attached to the actor.

KAI_Token_GetThreatLevel

Returns the threat level for the token attached to the actor.

KAI_Token_SetVelocityMonster

Only has one parameter, either true or false. Marking the non-KAI actor as being one that moves by actually changing its' momentum or not for KAI's Target prediction.

KAI_Token_GetVelocityMonster

Returns whether or not the tokens' VelocityMonster flag is set to true or false.

KAI_Token_SetDeflectChance

Sets the chance of the actor with this token deflecting a deflectable KAI_BaseProjectile.

KAI_Token_GetDeflectChance

Gets the deflection chance of the data token being wielded by the actor.

KAI_Token_SetDeflectDamageFactor

Sets the multiplier by which the damage of the projectile is altered when it impacts the actor.

KAI_Token_GetDeflectDamageFactor

Gets the damage factor from the token on the actors' inventory.

KAI_Token_SetDeflectSpeedFactor

Sets the multiplier by which the velocity of the projectile is altered when it impacts the actor.

KAI_Token_GetDeflectSpeedFactor

Gets the speed factor from the token on the actors' inventory.

ScriptCall functions

This is a list of all the static ZScript functions included in the library, that are meant to be callable from ACS using ScriptCall(). These ones are used for affecting KAI NPCs from ACS, such as for scripted events.

Functions

KAI_NPCGroup.CreateGroupACS()

Allows for forming an NPC group from ACS. The group leader will be the scripts' activator. More info here.

KAI_Actor.ACS_SetNPCOrder()

Sets the current order for every NPC with a matching TID through ACS. The commander that made the order (If any) will be the activator. More info here.

See also

• Mod interoperability