Knight's Sanity

This library will not function if your server doesn't have Knight's Sanity installed:

• Knight's Sanity Legacy
• Knight's Sanity Enhanced

General

AoE Shapes (Reference sheet)

Type	Index	Shape
Point	0	Point
Point	1	Sphere
Point	2	Cylinder
MultiPoint	0	Wall
Directional	0	Cone
Directional	1	Line
Directional	2	Cube

PushCharacter function

Syntax:

void KS.PushCharacter( Character player, Vector origin, float distance, bool pull, bool sweep )

SelectCharacters function

Syntax:

void KS.SelectCharacters( Character player, int targets, float maxDistance, table<string> allowedTargetTypes, bool allowPartial, bool allowRepeat, string command, string title )

Possible Target Types:

Players

Self

Puppets

NPC

SelectPoint function

Syntax:

void KS.SelectPoint( Character player, int shape, float maxDistance, float radius, float height, string command, Color color, string title )

SelectMultiPoint function

Syntax:

void KS.SelectMultiPoint( Character player, int shape, float maxDistance, float length, float width, float height, string command, Color color )

SelectDirection function

Syntax:

void KS.SelectDirection( Character player, int shape, float length, float width, string command, Color color, string title )

ProcessAoE function

Syntax:

void KS.ProcessAoE( Character player, Vector point, int shape, float radius, float height, bool visualize, bool trace, Color color )

ProcessMultiPointAoE function

Syntax:

void KS.ProcessMultiPointAoE( Character player, Vector first, Vector second, int shape, float width, float height, bool visualize, bool trace, Color color )

ProcessDirectionalAoE function

Syntax:

void KS.ProcessDirectionalAoE( Character player, Vector point, Rotator direction, int shape, float length, float width, bool visualize, bool trace, Color color )

GetSelectedPoints function

Syntax:

Vector, Vector, Rotator KS.GetSelectedPoints( Character player )

GetSelectedCharacters function

Syntax:

table<Character|TotPuppet> KS.GetSelectedCharacters( Character player )

InfoBox function

Syntax:

void KS.InfoBox( Character player, string title, string content )

CombatTracker function

Syntax:

void KS.CombatTracker( Character player [, table<string> playerNames = {}, int activeTurn = -1 ] )

CreateCUI function

Shows a Custom User Interface to a player. Generate definition code using cui.ratajmods.net.

Syntax:

void KS.CreateCUI( Character player, string definition )

Redlight function

Toggle redlight warning on screen of all players.

Syntax:

void KS.Redlight( bool enabled [, bool blocking = false ] )

Volumes

Volumes are static visualized areas, they can represent lasting area of effect, or anything else. They have essentially no functionality and only serve as visualizers.

KSVolume constructor

KSVolume can be constructed directly using a function of the same name.

Syntax:

KSVolume KSVolume( Vector location, string shape, table options )

Shape	Options
Sphere	radius, color
Cylinder	radius, height, color

GetColor function

Syntax:

Color KSVolume:GetColor()

GetRadius function

Syntax:

float KSVolume:GetRadius()

GetHeight function

Syntax:

float KSVolume:GetHeight()

GetShape function

Syntax:

string KSVolume:GetShape()

SetColor function

Syntax:

void KSVolume:SetColor( Color color )

SetRadius function

Syntax:

void KSVolume:SetRadius( float radius )

SetHeight function

Syntax:

void KSVolume:SetHeight( float height )