Classes
class	array< T >

class	kStr
	String class functions. More...

class	kAngle
	Angle functions. More...

class	kVec3
	Representation of 3D vectors and points. More...

class	kQuat
	Quaternions used to represent rotations. More...

class	kPlane
	Plane functions. More...

class	kColor
	< Not used (included automatically from kexengine) More...

class	kBitDelta
	< Not used (garbage included automatically from kexengine) More...

class	kexTranslation
	< Not used (garbage included automatically from kexengine) More...

class	ref

class	kScriptObject

class	kScriptObjectFx

class	ScriptObject
	Actor script classes must inherit from this class. More...

class	ScriptObjectWeapon
	Weapon script classes must inherit from this class. More...

class	ScriptObjectPlayer
	Player script class must inherit from this class. More...

class	ScriptObjectFx
	Fx script class must inherit from this class. More...

class	kDict
	Editable Dictionary object that holds keys and values. More...

class	kDictMem
	Read only Dictionary object that holds keys and values. More...

class	kSelectionListInt
	For selecting a int value based on weights. More...

class	kSelectionListFloat
	For selecting a float value based on weights. More...

class	kRenderModel

class	kAnimState

class	kActor
	Base type used by all actors. More...

class	kActorIterator
	The way to iterate through all actors in the map. Example code: More...

class	kWeapon

class	kAI

class	kPuppet

class	kActorFactory
	For Spawning Actors. More...

class	kFx

class	kCamera

class	kCModel
	The kCModel(CModel) global stores collision results when certain actor methods are called. Those methods are as follows: GetSectorIndexAtLocation const bool CanSee(kActor@, const uint = 0) MoveToPosition SpawnProjectile bool CheckPosition(const kVec3 &in) More...

class	kPlayLoop

class	kSys

class	kWorld

class	kGame

class	kFxIterator
	The way to iterate through all Fx in the map. Example code: More...

class	kPlayer

class	kScriptTMap
	A map/dictionary that stores key/values as kStr. Example code to iterate each key/value: More...

Namespaces
namespace	kexVibrationPlayer

namespace	kexColors
	< Not used (garbage included automatically from kexengine)

Enumerations
enum	EnumPlaneSide { PSIDE_FRONT = 0 , PSIDE_BACK = 1 , PSIDE_ON = 2 }

enum	kexLocPlatform_e { LocPlatform_UserPlatformCount = 8 , LocPlatform_Windows = 1 , LocPlatform_Linux = 2 , LocPlatform_Mac = 4 , LocPlatform_Switch = 8 , LocPlatform_XboxOne = 16 , LocPlatform_PlayStation4 = 32 , LocPlatform_XboxSeries = 64 , LocPlatform_WindowsStore = 128 , LocPlatform_PlayStation5 = 256 , LocPlatform_FirstUserPlatform = 16777216 , LocPlatform_Current = 1 }
	< Not used (garbage included automatically from kexengine) More...

enum	EnumAnimStateFlags { ANF_BLEND = 1 << 0 , ANF_LOOP = 1 << 1 , ANF_STOPPED = 1 << 2 , ANF_NOINTERRUPT = 1 << 3 , ANF_ROOTMOTION = 1 << 4 , ANF_PAUSED = 1 << 5 , ANF_CYCLECOMPLETED = 1 << 6 , ANF_LINEARBLEND = 1 << 7 }

enum	EnumActorFlags { AF_SOLID = 1 << 0 , AF_DORMANT = 1 << 1 , AF_SNAPTOFLOOR = 1 << 2 , AF_CLIMBWALLS = 1 << 3 , AF_WOUNDEDMORTALLY = 1 << 4 , AF_CASTSHADOW = 1 << 5 , AF_TRIGGERSTUFF = 1 << 6 , AF_HIDDEN = 1 << 7 , AF_ACTIVATED = 1 << 8 , AF_DISABLED = 1 << 9 , AF_ENTEREDAREAEVENT = 1 << 10 , AF_REMOVEONCOMPLETION = 1 << 11 , AF_NOBLOOD = 1 << 12 , AF_AVOIDWATER = 1 << 13 , AF_FLOATINWATERONDEATH = 1 << 14 , AF_DEAD = 1 << 15 , AF_STATIONARY = 1 << 16 , AF_ALIGNTOFLOOR = 1 << 17 , AF_NODRAW = 1 << 18 , AF_NONSHOOTABLE = 1 << 19 , AF_FULLVOLUME = 1 << 20 , AF_CANBETOUCHED = 1 << 21 , AF_IGNORESOUNDEVENTS = 1 << 22 , AF_TRIGGERANIMATION = 1 << 23 , AF_HOLDTRIGGERANIM = 1 << 24 , AF_TRIGGERNAIMDELAY = 1 << 25 , AF_STAYINWATER = 1 << 26 , AF_ALWAYSACTIVE = 1 << 27 , AF_COLLIDEDWITHWALL = 1 << 28 , AF_INVINCIBLE = 1 << 29 , AF_ALLOWTINYENEMYCHEAT = 1 << 30 , AF_NOMOVEMENT = 1 << 31 }

enum	EnumActorSpawnFlags1 { ASF1_SOLID = 1 << 0 , ASF1_PROJECTILEATTACK1 = 1 << 1 , ASF1_LEADER = 1 << 2 , ASF1_SNAPTOFLOOR = 1 << 3 , ASF1_EXPLOSIONDEATH = 1 << 4 , ASF1_CLIMBWALLS = 1 << 5 , ASF1_PROJECTILEATTACK2 = 1 << 6 , ASF1_NOREPEATEXPLOSION = 1 << 7 , ASF1_DIEONEXPLOSION = 1 << 8 , ASF1_FLOCKER = 1 << 9 , ASF1_SLOW = 1 << 10 , ASF1_RANDOMRESURRECTION = 1 << 11 , ASF1_RANDOMFEIGNDEATH = 1 << 12 , ASF1_KAMIKAZE = 1 << 13 , ASF1_AVOIDPLAYERS = 1 << 14 , ASF1_FLOATINWATERONDEATH = 1 << 15 , ASF1_TELEPORT = 1 << 16 , ASF1_CASTSHADOW = 1 << 17 , ASF1_TELEPORTWAIT = 1 << 18 , ASF1_USESTRONGATTACKS = 1 << 19 , ASF1_USEWEAKATTACKS = 1 << 20 , ASF1_SNIPER = 1 << 21 , ASF1_MELTONDEATH = 1 << 22 , ASF1_AVOIDWATER = 1 << 23 , ASF1_FLYING = 1 << 24 , ASF1_TELEPORTAVOIDWATER = 1 << 25 , ASF1_TELEPORTAVOIDCLIFFS = 1 << 26 , ASF1_TRIGGERSTUFF = 1 << 27 , ASF1_CANNOTCAUSEAFIGHT = 1 << 28 , ASF1_NOWALLCOLLISION = 1 << 29 , ASF1_SCREENSHAKE = 1 << 30 , ASF1_RESPAWNANIMATION = 1 << 31 }

enum	EnumActorSpawnFlags2 { ASF2_DROPITEM_MASK1 = 1 << 0 , ASF2_DROPITEM_MASK2 = 1 << 1 , ASF2_DROPITEM_MASK3 = 1 << 2 , ASF2_DROPITEM_MASK4 = 1 << 3 , ASF2_DROPITEM_MASK5 = 1 << 4 , ASF2_DROPITEM_MASK6 = 1 << 5 , ASF2_DROPITEM_MASK7 = 1 << 6 , ASF2_DROPITEM_MASK8 = 1 << 7 , ASF2_DROPITEM_MASK9 = 1 << 8 , ASF2_DROPITEM_MASK10 = 1 << 9 , ASF2_DROPITEM_MASK11 = 1 << 10 , ASF2_DROPITEM_MASK12 = 1 << 11 , ASF2_DROPITEM_MASK13 = 1 << 12 , ASF2_DROPITEM_MASK14 = 1 << 13 , ASF2_REMOVEONCOMPLETION = 1 << 14 , ASF2_NOBLOOD = 1 << 15 , ASF2_HOLDTRIGGERANIMATION = 1 << 16 , ASF2_PROJECTILEATTACK3 = 1 << 17 , ASF2_PROJECTILEATTACK4 = 1 << 18 , ASF2_DROPITEMONDAMAGE = 1 << 19 , ASF2_NOAUTOMAPDRAW = 1 << 20 , ASF2_ALTERNATEMOVES = 1 << 21 , ASF2_UNUSED1 = 1 << 22 , ASF2_UNUSED2 = 1 << 23 , ASF2_PROJECTILEATTACK5 = 1 << 24 , ASF2_PROJECTILEATTACK6 = 1 << 25 , ASF2_MORTALWOUNDIMPACT = 1 << 26 , ASF2_STAYINWATER = 1 << 27 , ASF2_WARPDEATH = 1 << 28 , ASF2_STOREWARPRETURN = 1 << 29 , ASF2_PROJECTILEATTACK7 = 1 << 30 , ASF2_PROJECTILEATTACK8 = 1 << 31 }

enum	EnumActorSpawnFlags3 { ASF3_RETURNWARP = 1 << 0 , ASF3_PLAYTRIGGERANIMONCE = 1 << 1 , ASF3_REGENERATEFROMSTART = 1 << 2 , ASF3_WALKINSTRAIGHTLINE = 1 << 3 , ASF3_KILLOUTSIDEOFVIEW = 1 << 4 , ASF3_NOTHINKER = 1 << 5 , ASF3_AVOIDPLAYERS2 = 1 << 6 , ASF3_NOVIOLENTDEATH = 1 << 7 , ASF3_PROJECTILEATTACK9 = 1 << 8 , ASF3_PROJECTILEATTACK10 = 1 << 9 , ASF3_MAKESPAWNANIMVISIBLE = 1 << 10 , ASF3_NODRAWONCAMERA = 1 << 11 }

enum	EnumPlayerFlags { PF_NOCLIP = 1 << 0 , PF_FLY = 1 << 1 , PF_DEAD = 1 << 2 , PF_GOD = 1 << 3 , PF_JUMPING = 1 << 4 , PF_HASJUMPED = 1 << 5 , PF_INWARPAREA = 1 << 6 , PF_CLIMBTHRUST = 1 << 7 , PF_NOAIRFRICTION = 1 << 8 , PF_CRAWLING = 1 << 9 , PF_PREVENTDEATHCAM = 1 << 10 , PF_FIREDPROJECTILE = 1 << 11 , PF_FALLINGDEATHPIT = 1 << 12 , PF_WEAPONSTEAL = 1 << 13 , PF_NOSECTORMUSIC = 1 << 14 , PF_NOTOUCH = 1 << 15 , PF_NOCEILINGGLIDE = 1 << 16 }

enum	EnumPlayerStates { PS_WALKING = 0 , PS_JUMPING = 1 , PS_CLIMBING = 2 , PS_SWIMMING = 3 , PS_UNDERWATER = 4 , PS_FALLDEATH = 5 , PS_ANTIGRAVITY = 6 }

enum	EnumCheatFlags { GC_BIG_HEADS = 1 << 0 , GC_TINY_ENEMY = 1 << 1 , GC_INFINITE_AMMO = 1 << 2 , GC_PURDY_COLORS = 1 << 3 , GC_SPIRIT_MODE = 1 << 4 , GC_INVINCIBILITY = 1 << 5 , GC_FLIGHT = 1 << 6 , GC_DISCO = 1 << 7 , GC_INFINITE_LIVES = 1 << 8 , GC_ALL_MAP = 1 << 9 , GC_SHOW_ENEMIES = 1 << 10 , GC_NOCLIP = 1 << 11 }

enum	EnumAIFlags { AIF_ATTACKING = 1 << 0 , AIF_WASSOLID = 1 << 1 , AIF_FIRSTATTACK = 1 << 2 , AIF_HEARDLOUDNOISE = 1 << 3 , AIF_BLOWNAWAY = 1 << 4 , AIF_GOBACKTOLEASH = 1 << 5 , AIF_RESSURECT = 1 << 6 , AIF_FEIGNDEATH = 1 << 7 , AIF_REGENERATE = 1 << 8 , AIF_SEETARGET = 1 << 9 , AIF_NOCHASE = 1 << 10 , AIF_REGENERATEANIM = 1 << 11 , AIF_NOTHINK = 1 << 12 , AIF_RUNNING = 1 << 13 , AIF_GETATTENTION = 1 << 14 , AIF_REGENANIMDELAY = 1 << 15 , AIF_HEARDQUIETNOISE = 1 << 16 , AIF_AWAYFROMLEASH = 1 << 17 , AIF_TELEPORTAWAY = 1 << 18 , AIF_TELEPORTMOVESLOW = 1 << 19 , AIF_TELEPORTING = 1 << 20 , AIF_TELEPORTIN = 1 << 21 , AIF_WAITFORCYCLE = 1 << 22 , AIF_DAMAGEPANIC = 1 << 23 }

enum	EnumImpactType { IT_DEFAULT = 0 , IT_WATER = 1 , IT_METAL = 2 , IT_STONE = 3 , IT_FLESH_HUMAN = 4 , IT_FLESH_CREATURE = 5 , IT_FLESH_UNDEAD = 6 , IT_LAVA = 7 , IT_SLIME = 8 , IT_FORCEFIELD = 9 }

enum	EnumGameFontType { GFT_BIG = 0 , GFT_SMALL = 1 , GFT_NUMBERS = 2 , GFT_TTF = 3 }

enum	EnumClipResultFlags { CRF_NOCOLLISION = 0 , CRF_FLOOR = 1 << 0 , CRF_CEILING = 1 << 1 , CRF_WALL = 1 << 2 , CRF_OBJECT = 1 << 3 , CRF_MESH = 1 << 4 , CRF_ADJUST = 1 << 5 , CRF_WALLRADIUS = 1 << 6 }

enum	EnumWeaponStates { WS_IDLE = 0 , WS_RAISE = 1 , WS_LOWER = 2 , WS_FIRE = 3 , WS_HOLDSTER = 4 , WS_WALK = 5 , WS_RUN = 6 , WS_DISCHARGE = 7 , WS_FIREUNDERWATER = 8 }

enum	EnumInputActions { IA_ATTACK = 0 , IA_JUMP = 1 , IA_FORWARD = 2 , IA_BACKWARD = 3 , IA_STRAFELEFT = 4 , IA_STRAFERIGHT = 5 , IA_WEAPNEXT = 6 , IA_WEAPPREV = 7 , IA_MAPZOOMIN = 8 , IA_MAPZOOMOUT = 9 , IA_CUSTOM1 = 10 , IA_CUSTOM2 = 11 }

enum	EnumPlayerButtons { BC_ATTACK = 1 << 0 , BC_JUMP = 1 << 1 , BC_FORWARD = 1 << 2 , BC_BACKWARD = 1 << 3 , BC_STRAFELEFT = 1 << 4 , BC_STRAFERIGHT = 1 << 5 , BC_WEAPONRIGHT = 1 << 6 , BC_WEAPONLEFT = 1 << 7 , BC_MAPZOOMIN = 1 << 8 , BC_MAPZOOMOUT = 1 << 9 , BC_CUSTOM1 = 1 << 10 , BC_CUSTOM2 = 1 << 11 }

enum	EnumPlayerConButtons { CBC_WEAPON1 = 1 << 0 , CBC_WEAPON2 = 1 << 1 , CBC_WEAPON3 = 1 << 2 , CBC_WEAPON4 = 1 << 3 , CBC_WEAPON5 = 1 << 4 , CBC_WEAPON6 = 1 << 5 , CBC_WEAPON7 = 1 << 6 , CBC_WEAPON8 = 1 << 7 , CBC_WEAPON9 = 1 << 8 , CBC_WEAPON10 = 1 << 9 , CBC_WEAPON11 = 1 << 10 , CBC_WEAPON12 = 1 << 11 , CBC_WEAPON13 = 1 << 12 , CBC_WEAPON14 = 1 << 13 , CBC_AUTOMAP = 1 << 14 , CBC_CHANGEAMMO = 1 << 15 , CBC_RUNWALK = 1 << 16 , CBC_MENUUP = 1 << 17 , CBC_MENUDOWN = 1 << 18 , CBC_MENULEFT = 1 << 19 , CBC_MENURIGHT = 1 << 20 , CBC_MENUSELECT = 1 << 21 , CBC_MENUDESELECT = 1 << 22 , CBC_MENUBACK = 1 << 23 , CBC_MENUCANCEL = 1 << 24 , CBC_MENUACTIVATE = 1 << 25 }

enum	EnumGameButtonEvents { GBE_MENU_UP = 1 << 0 , GBE_MENU_RIGHT = 1 << 1 , GBE_MENU_DOWN = 1 << 2 , GBE_MENU_LEFT = 1 << 3 , GBE_MENU_SELECT = 1 << 4 , GBE_MENU_CANCEL = 1 << 5 , GBE_MENU_BACK = 1 << 6 , GBE_MENU_ACTIVATE = 1 << 7 , GBE_MENU_DESELECT = 1 << 8 , GBE_MENU_MOUSESELECT = 1 << 9 }

enum	EnumDifficulty { DIFFICULTY_EASY = 0 , DIFFICULTY_NORMAL = 1 , DIFFICULTY_HARD = 2 , DIFFICULTY_HARDCORE = 3 }

enum	EnumClipFlags { CF_CLIPEDGES = 1 << 0 , CF_IGNOREBLOCKERS = 1 << 1 , CF_DROPOFF = 1 << 2 , CF_NOENTERWATER = 1 << 3 , CF_NOEXITWATER = 1 << 4 , CF_NOCLIPSTATICS = 1 << 5 , CF_NOCLIPACTORS = 1 << 6 , CF_WALKWALLS = 1 << 7 , CF_COLLIDEFLOORS = 1 << 8 , CF_HITSCAN = 1 << 9 , CF_ALLOWCLIMB = 1 << 10 , CF_ALLOWCRAWL = 1 << 11 , CF_NOSTEPDOWN = 1 << 12 , CF_NOSLOPESTEP = 1 << 13 , CF_COLLIDEHEIGHT = 1 << 14 , CF_COLLIDECORPSES = 1 << 15 , CF_NOEXITWALLS = 1 << 16 , CF_NOCOLLIDEFUNC = 1 << 17 , CF_NOFLOORADJUST = 1 << 18 , CF_NOCEILINGADJUST = 1 << 19 , CF_COLLIDEWATER = 1 << 20 , CF_USEWALLRADIUS = 1 << 21 , CF_NOCLIPTARGETACTORS = 1 << 22 , CF_COLLIDETRIGGERS = 1 << 23 , CF_STANDONOBJECTS = 1 << 24 , CF_GREASESLIDEOBJECTS = 1 << 25 , CF_ALLOWRESTRICTEDAREAS = 1 << 26 , CF_COLLIDECLIFFS = 1 << 27 , CF_CHECKLINKEDBRIDGES = 1 << 28 , CF_POLYCOLLISION = 1 << 29 , CF_COLLIDEPLAYERBLOCKER = 1 << 30 }

enum	EnumWaterLevel { WLT_INVALID = 0 , WLT_OVER = 1 , WLT_BETWEEN = 2 , WLT_UNDER = 3 }

enum	EnumCameraLerpType { CMLT_NONE = 0 , CMLT_LINEAR = 1 , CMLT_LINEARLOOP = 2 , CMLT_COSINE = 3 , CMLT_COSINE_POW = 4 }
	Lerp type when doing AutoPlayPositionTrack, AutoPlayRotationTrack, or AutoPlayBlendTrack. When a view has one of those active the view's time variable is then increased by GAME_DELTA_TIME. More...

enum	EnumCameraFlags { CMF_NO_INITIAL_FADEOUT = 1 << 0 , CMF_NO_LETTERBOX = 1 << 1 , CMF_LOCK_PLAYER = 1 << 2 , CMF_UNLOCK_PLAYER_ON_FINISH = 1 << 3 , CMF_INITIAL_FADEIN = 1 << 4 , CMF_SHOW_CREDITS = 1 << 5 , CMF_CHANGE_MAP_AFTER_FADE = 1 << 6 , CMF_SHOW_HIDDEN_OBJECTS = 1 << 7 , CMF_NO_INITIAL_FADEIN = 1 << 8 , CMF_NO_SUNLENSFLARE = 1 << 9 }

enum	EnumCameraStates { CAMS_IDLE = 0 , CAMS_FADEOUT = 1 , CAMS_FADEIN = 2 , CAMS_ACTIVE = 3 , CAMS_ACTIVE_TO_FADEOUT = 4 , CAMS_FADEBACK_TO_CLIENT = 5 , CAMS_RESTORE_TO_CLIENT = 6 }

enum	EnumAreaFlags { AAF_WATER = 1 << 0 , AAF_BLOCK = 1 << 1 , AAF_TOGGLE = 1 << 2 , AAF_CLIFF = 1 << 3 , AAF_CLIMB = 1 << 4 , AAF_ONESIDED = 1 << 5 , AAF_CEILING = 1 << 6 , AAF_CRAWL = 1 << 7 , AAF_ENTERCRAWL = 1 << 8 , AAF_HIDDEN = 1 << 9 , AAF_ENTERED = 1 << 10 , AAF_SECRET = 1 << 11 , AAF_RESTRICTED = 1 << 12 , AAF_SLOPETEST = 1 << 13 , AAF_DEATHPIT = 1 << 14 , AAF_MAPPED = 1 << 15 , AAF_EVENT = 1 << 16 , AAF_REPEATABLE = 1 << 17 , AAF_TELEPORT = 1 << 18 , AAF_DAMAGE = 1 << 19 , AAF_DRAWSKY = 1 << 20 , AAF_TELEPORTAIR = 1 << 21 , AAF_LAVA = 1 << 22 , AAF_EVENTSOUND = 1 << 23 , AAF_ANTIGRAVITY = 1 << 24 , AAF_LADDER = 1 << 25 , AAF_CHECKPOINT = 1 << 26 , AAF_SAVEGAME = 1 << 27 , AAF_WARPRETURN = 1 << 28 , AAF_SHALLOWWATER = 1 << 29 , AAF_DRAWSUN = 1 << 30 , AAF_STOREWARPRETURN = 1 << 31 }

enum	EnumSectorPlatformFlags { SPF_FLOORVERTS = 1 << 0 , SPF_CEILINGVERTS = 1 << 1 , SPF_SAMEAREA = 1 << 2 , SPF_MOVEPLAYERINAIR = 1 << 3 , SPF_USEMOVETOFORPLAYER = 1 << 4 , SPF_USEMOVETOFORAI = 1 << 5 , SPF_USEMOVETOFOROTHER = 1 << 6 , SPF_MOVEPLAYER = 1 << 7 , SPF_MOVEAI = 1 << 8 , SPF_MOVEOTHERACTORS = 1 << 9 , SPF_DEFAULT = SPF_FLOORVERTS\|SPF_CEILINGVERTS\|SPF_MOVEPLAYERINAIR\|SPF_USEMOVETOFORPLAYER\|SPF_MOVEPLAYER\|SPF_MOVEAI\|SPF_MOVEOTHERACTORS }

enum	EnumCustomHUDFlags { CHF_HIDECINEMA = 1 << 0 , CHF_HIDEMENU = 1 << 1 , CHF_HIDEDUMMYMENU = 1 << 2 , CHF_HIDENOHUD = 1 << 3 , CHF_ALPHASCALE = 1 << 4 }

enum	kexVibrationPlayer::channel_e { kexVibrationPlayer::CHANNEL_WEAPON = 0 , kexVibrationPlayer::CHANNEL_BODY = 1 , kexVibrationPlayer::CHANNEL_DAMAGE = 2 , kexVibrationPlayer::CHANNEL_WORLD = 3 }

enum	kexVibrationPlayer::position_e { kexVibrationPlayer::POSITION_LEFT = 0 , kexVibrationPlayer::POSITION_RIGHT = 1 , kexVibrationPlayer::POSITION_NEUTRAL = 2 }

Functions
class kScriptTMap	Sin (float f)
	Returns the sine of angle f in radians.

void	ItBegin ()
	Resets the iterator back to the first key/value.

bool	ItNext (kStr &out key, kStr &out value)
	key and value is set to the next key/value in the iterator. Returns false if reached the end.

bool	Add (const kStr &in key, const kStr &in value)
	if the key doesn't exist then adds the key/value and returns false. If the key already exists then sets the value and returns true.

bool	Find (const kStr &in key, kStr &out value)
	if the key exists then sets value and returns true. If key was not found then returns false.

bool	HasKey (const kStr &in key)
	Returns true if the key exists.

bool	Remove (const kStr &in key)
	Removes the key if it exists and returns true.

void	Clear ()

bool	IsEmpty ()

uint	Count ()

float	Cos (float f)
	Returns the cosine of angle f in radians.

float	Tan (float f)
	Returns the tangent of angle f in radians.

float	ATan2 (float y, float x)
	Returns the angle in radians whose Tan is y/x.

float	Fabs (float f)
	Returns the absolute value of f.

float	ACos (float f)
	Returns the arc-cosine of f - the angle in radians whose cosine is f.

float	Sqrt (float f)
	Returns square root of f.

int	Abs (int i)
	Returns the absolute value of i.

float	Ceil (float f)
	Returns the smallest integer greater to or equal to f.

float	Floor (float f)
	Returns the largest integer smaller to or equal to f.

float	Log (float f)
	Returns the natural (base e) logarithm of a specified number.

float	Pow (float x, float y)
	Returns f raised to power p.

float	Deg2Rad (float degs)
	Degrees-to-radians conversion.

float	Rad2Deg (float rads)
	Radians-to-Degrees conversion.

float	InvSqrt (float f)
	Returns inverse square root of f.

float	IncMax (const float val, const float inc, const float dest)
	returns val +(or minus) inc and never goes above or below dest value

int	SysRand ()
	Range 0..32767.

int	Rand ()
	Range 0..32767.

uint8	RandByte ()
	Range 0..255.

int	RandMax (const int max)
	Range 0..max-1.

float	NLerp (const float a, const float b, const float t)
	Calculates the linear parameter t that produces the interpolant value within the range [a, b].

float	Accelerate (const float val, const float accel, const float max)
	return val that increases by accel in a weird way to the max value.

float	RandFloat ()
	Range 0..1.

float	RandCFloat ()
	Range -1..1.

float	RandRange (const float min, const float max)
	Returns a random float number between and min [inclusive] and max [inclusive].

int	Clamp (const int i, const int min, const int max)
	Returns clamped value between min and max.

float	Clampf (const float f, const float min, const float max)
	Returns clamped value between min and max.

float	Lerp (float start, const float end, const float time)
	Linearly interpolates between start and end by time.

float	CosTween (const float t)
	return (0.5f - (Cos(t * pi) * 0.5f));

float	CosArc (const float t)
	return (-((Cos(Deg2Rad(360.0f * t)) - 1.0f) * 0.5f));

float	SmoothStep (const float from, const float to, const float t)
	Interpolates between min and max with smoothing at the limits.

float	HermiteBlend (const float a, const float b, const float t)

float	Min (const float a, const float b)
	Returns the smallest of the two values.

float	Max (const float a, const float b)
	Returns the largest of the two values.

const int	f2i (const float f)
	IEEE 754 float to int.

const float	i2f (const int i)
	int to IEEE 754 float

void	kStrSplit (const kStr &in s, const kStr &in sep)

kStr	kStrSplitGet (const int index)
	returns the string at index

uint	kStrSplitLength ()
	returns the amount of strings that were split

void	kStrSplitClear ()
	clear the list of split strings after your done. Not required to call because it gets cleared when you call kStrSplit but if you don't want those strings still hanging around you can clear them now.

void	GameVarsSetAdd (const kStr &in key, const kStr &in value)
	Adds the key and value to GameVariables if it doesn't exist otherwise sets the existing keys value.

void	GameModFileDataSetAdd (const kStr &in key, const kStr &in value)
	Adds the key and value to GameModFileData if it doesn't exist otherwise sets the existing keys value.

kColor	kexColor_FromHSL (float hue, float sat, float lit)
	Not used. (garbage from kexengine)

kColor	kexColor_Random ()
	Not used. (garbage from kexengine)

kColor	kexColor_Tab20 (uint i)
	Not used. (garbage from kexengine)

kColor	kexColor_Tab20Dark (uint i)
	Not used. (garbage from kexengine)

kColor	kexColor_Tab20Light (uint i)
	Not used. (garbage from kexengine)

kColor	kexColor_ViridisScale (float v)
	Not used. (garbage from kexengine)

kColor	kexColor_LerpRGB (const kColor &in from, const kColor &in to, float time)
	Not used. (garbage from kexengine)

int	kexRandInt ()
	Range -2147483648..2147483647.

uint	kexRandUInt ()
	Range 0..4294967295.

void	delay (const float time)
	used in map scripts to delay execution of script

Variables
enum kexVibrationPlayer::channel_e	kexVibrationPlayer::Sin

const float	pi = 3.1415927f

const float	tau = 6.2831855f
	pi * 2

const kVec3	vecZero (0.0f, 0.0f, 0.0f)

const kColor	kexColors::white
	255, 255, 255, 255

const kColor	kexColors::gray
	127, 127, 127, 255

const kColor	kexColors::black
	0, 0, 0, 255

const kColor	kexColors::red
	255, 0, 0, 255

const kColor	kexColors::green
	0, 255, 0, 255

const kColor	kexColors::blue
	0, 0, 255, 255

const kColor	kexColors::yellow
	255, 255, 0, 255

const kColor	kexColors::orange
	255, 127, 0, 255

const kColor	kexColors::cyan
	0, 255, 255, 255

const kColor	kexColors::magenta
	255, 0, 255, 255

const kColor	kexColors::transparent
	0, 0, 0, 0

const kColor	kexColors::tab20blue

const kColor	kexColors::tab20blue2

const kColor	kexColors::tab20orange

const kColor	kexColors::tab20orange2

const kColor	kexColors::tab20green

const kColor	kexColors::tab20green2

const kColor	kexColors::tab20red

const kColor	kexColors::tab20red2

const kColor	kexColors::tab20purple

const kColor	kexColors::tab20purple2

const kColor	kexColors::tab20brown

const kColor	kexColors::tab20brown2

const kColor	kexColors::tab20pink

const kColor	kexColors::tab20pink2

const kColor	kexColors::tab20grey

const kColor	kexColors::tab20grey2

const kColor	kexColors::tab20olive

const kColor	kexColors::tab20olive2

const kColor	kexColors::tab20cyan

const kColor	kexColors::tab20cyan2

const float	GAME_FRAME_TIME = 0.25f

const float	GAME_DELTA_TIME = 0.016666668f

const float	GAME_FRAME_UNIT = 4.0f

const float	GAME_SECONDS = 0.06666667f

const float	GAME_SCALE = 10.24f

kSys	Sys

kDict	GameVariables

kDict	GameModFileData
	Use with Game.SaveModFile, Game.LoadModFile, and Game.LoadModDataFile.

kGame	Game

kActorFactory	ActorFactory

kPlayLoop	PlayLoop

kPlayer	Player

kCamera	Camera

kWorld	World

kCModel	CModel

Enumeration Type Documentation

◆ EnumActorFlags

enum EnumActorFlags

Enumerator
AF_SOLID	1 << 0	Can be collided.
AF_DORMANT	1 << 1	if on then is asleep (won't be updated onTick) else is awake
AF_SNAPTOFLOOR	1 << 2	adjust z-axis to floor on spawn
AF_CLIMBWALLS	1 << 3	allows entering of wall sectors
AF_WOUNDEDMORTALLY	1 << 4	if on this actor will drop a mortal wound because it was hit by a super arrow shot
AF_CASTSHADOW	1 << 5	can cast a simple shadow
AF_TRIGGERSTUFF	1 << 6	NOT USED.
AF_HIDDEN	1 << 7	don't draw but continue updating. can't be collided
AF_ACTIVATED	1 << 8	was triggered
AF_DISABLED	1 << 9	don't update animations
AF_ENTEREDAREAEVENT	1 << 10	just entered a trigger sector
AF_REMOVEONCOMPLETION	1 << 11	remove after finishing a special animation
AF_NOBLOOD	1 << 12	don't spawn particles flagged as blood
AF_AVOIDWATER	1 << 13	clip against edges linking to water sectors
AF_FLOATINWATERONDEATH	1 << 14	rise to the surface while dead
AF_DEAD	1 << 15	actor is dead. handle special cases for collision
AF_STATIONARY	1 << 16	Sniper. don't update the animation's root motion.
AF_ALIGNTOFLOOR	1 << 17	rotate along slopes
AF_NODRAW	1 << 18	don't render
AF_NONSHOOTABLE	1 << 19	Fx won't hit actors if this flag is set.
AF_FULLVOLUME	1 << 20	all sounds coming from this actor will be heard at full volume
AF_CANBETOUCHED	1 << 21	allow invoking the OnTouch callback
AF_IGNORESOUNDEVENTS	1 << 22	don't call kexAnimState::Action_PlaySound
AF_TRIGGERANIMATION	1 << 23	play special animation on trigger/spawn
AF_HOLDTRIGGERANIM	1 << 24	pause special animation until triggered (is also invincible)
AF_TRIGGERNAIMDELAY	1 << 25	delay a bit before starting special animation
AF_STAYINWATER	1 << 26	can't exit water sectors
AF_ALWAYSACTIVE	1 << 27	never sleep or go dormant
AF_COLLIDEDWITHWALL	1 << 28	collided with an edge. cleared at every OnTick call
AF_INVINCIBLE	1 << 29	will not receive damage. OnDamage and OnDeath are never called
AF_ALLOWTINYENEMYCHEAT	1 << 30	affected by tiny enemy game cheat
AF_NOMOVEMENT	1 << 31	will not do collision movement

Definition at line 36 of file t1_scriptAPI.cpp.

{
    AF_SOLID                = 1 << 0,  ///< Can be collided
    AF_DORMANT              = 1 << 1,  ///< if on then is asleep (won't be updated onTick) else is awake
    AF_SNAPTOFLOOR          = 1 << 2,  ///< adjust z-axis to floor on spawn
    AF_CLIMBWALLS           = 1 << 3,  ///< allows entering of wall sectors
    AF_WOUNDEDMORTALLY      = 1 << 4,  ///< if on this actor will drop a mortal wound because it was hit by a super arrow shot
    AF_CASTSHADOW           = 1 << 5,  ///< can cast a simple shadow
    AF_TRIGGERSTUFF         = 1 << 6,  ///< NOT USED
    AF_HIDDEN               = 1 << 7,  ///< don't draw but continue updating. can't be collided
    AF_ACTIVATED            = 1 << 8,  ///< was triggered
    AF_DISABLED             = 1 << 9,  ///< don't update animations
    AF_ENTEREDAREAEVENT     = 1 << 10, ///< just entered a trigger sector
    AF_REMOVEONCOMPLETION   = 1 << 11, ///< remove after finishing a special animation
    AF_NOBLOOD              = 1 << 12, ///< don't spawn particles flagged as blood
    AF_AVOIDWATER           = 1 << 13, ///< clip against edges linking to water sectors
    AF_FLOATINWATERONDEATH  = 1 << 14, ///< rise to the surface while dead
    AF_DEAD                 = 1 << 15, ///< actor is dead. handle special cases for collision
    AF_STATIONARY           = 1 << 16, ///< Sniper. don't update the animation's root motion
    AF_ALIGNTOFLOOR         = 1 << 17, ///< rotate along slopes
    AF_NODRAW               = 1 << 18, ///< don't render
    AF_NONSHOOTABLE         = 1 << 19, ///< Fx won't hit actors if this flag is set.
    AF_FULLVOLUME           = 1 << 20, ///< all sounds coming from this actor will be heard at full volume
    AF_CANBETOUCHED         = 1 << 21, ///< allow invoking the OnTouch callback
    AF_IGNORESOUNDEVENTS    = 1 << 22, ///< don't call kexAnimState::Action_PlaySound
    AF_TRIGGERANIMATION     = 1 << 23, ///< play special animation on trigger/spawn
    AF_HOLDTRIGGERANIM      = 1 << 24, ///< pause special animation until triggered (is also invincible)
    AF_TRIGGERNAIMDELAY     = 1 << 25, ///< delay a bit before starting special animation
    AF_STAYINWATER          = 1 << 26, ///< can't exit water sectors
    AF_ALWAYSACTIVE         = 1 << 27, ///< never sleep or go dormant
    AF_COLLIDEDWITHWALL     = 1 << 28, ///< collided with an edge. cleared at every OnTick call
    AF_INVINCIBLE           = 1 << 29, ///< will not receive damage. OnDamage and OnDeath are never called
    AF_ALLOWTINYENEMYCHEAT  = 1 << 30, ///< affected by tiny enemy game cheat
    AF_NOMOVEMENT           = 1 << 31  ///< will not do collision movement
};

◆ EnumActorSpawnFlags1

enum EnumActorSpawnFlags1

Enumerator
ASF1_SOLID	1 << 0
ASF1_PROJECTILEATTACK1	1 << 1	High Priest Flame Attack (anim_aiRangeAttack1)
ASF1_LEADER	1 << 2	Flocker ai run toward Leaders to get attention.
ASF1_SNAPTOFLOOR	1 << 3
ASF1_EXPLOSIONDEATH	1 << 4	NOT USED.
ASF1_CLIMBWALLS	1 << 5
ASF1_PROJECTILEATTACK2	1 << 6	Pistol Fire (anim_aiRangeAttack2)
ASF1_NOREPEATEXPLOSION	1 << 7	NOT USED.
ASF1_DIEONEXPLOSION	1 << 8	NOT USED.
ASF1_FLOCKER	1 << 9	flocks to a leader kAI
ASF1_SLOW	1 << 10	NOT USED.
ASF1_RANDOMRESURRECTION	1 << 11	NOT USED.
ASF1_RANDOMFEIGNDEATH	1 << 12	NOT USED.
ASF1_KAMIKAZE	1 << 13	if has no target then targets player and sets agitation to 300
ASF1_AVOIDPLAYERS	1 << 14	NOT USED.
ASF1_FLOATINWATERONDEATH	1 << 15	kAI will float up to the top of the water when they are dead
ASF1_TELEPORT	1 << 16	allows kAI to teleport on SetupAISpawnFlags
ASF1_CASTSHADOW	1 << 17	sets AF_CASTSHADOW on SetSpawnParams
ASF1_TELEPORTWAIT	1 << 18	allows enemy to move around for 1.5 - 4.5 seconds before teleporting back in.
ASF1_USESTRONGATTACKS	1 << 19	anim_aiMelee1
ASF1_USEWEAKATTACKS	1 << 20	anim_aiAltMelee1
ASF1_SNIPER	1 << 21
ASF1_MELTONDEATH	1 << 22	allows melt effect and regeneration
ASF1_AVOIDWATER	1 << 23	sets AF_AVOIDWATER on SetSpawnParams
ASF1_FLYING	1 << 24	NOT USED.
ASF1_TELEPORTAVOIDWATER	1 << 25
ASF1_TELEPORTAVOIDCLIFFS	1 << 26
ASF1_TRIGGERSTUFF	1 << 27	Sets AF_TRIGGERSTUFF on SetupSpawnParams.
ASF1_CANNOTCAUSEAFIGHT	1 << 28	if another actor was damaged by this actor with this flag set then other actor will not target this actor.
ASF1_NOWALLCOLLISION	1 << 29	NOT USED.
ASF1_SCREENSHAKE	1 << 30	Used in floor mover scripts to shake screen.
ASF1_RESPAWNANIMATION	1 << 31	Enables respawning animation effect.

Definition at line 72 of file t1_scriptAPI.cpp.

{
    ASF1_SOLID                  = 1 << 0,
    ASF1_PROJECTILEATTACK1      = 1 << 1,  ///< High Priest Flame Attack (anim_aiRangeAttack1)
    ASF1_LEADER                 = 1 << 2,  ///< Flocker ai run toward Leaders to get attention.
    ASF1_SNAPTOFLOOR            = 1 << 3,
    ASF1_EXPLOSIONDEATH         = 1 << 4,  ///< NOT USED
    ASF1_CLIMBWALLS             = 1 << 5,
    ASF1_PROJECTILEATTACK2      = 1 << 6,  ///< Pistol Fire (anim_aiRangeAttack2)
    ASF1_NOREPEATEXPLOSION      = 1 << 7,  ///< NOT USED
    ASF1_DIEONEXPLOSION         = 1 << 8,  ///< NOT USED
    ASF1_FLOCKER                = 1 << 9,  ///< flocks to a leader kAI
    ASF1_SLOW                   = 1 << 10, ///< NOT USED
    ASF1_RANDOMRESURRECTION     = 1 << 11, ///< NOT USED
    ASF1_RANDOMFEIGNDEATH       = 1 << 12, ///< NOT USED
    ASF1_KAMIKAZE               = 1 << 13, ///< if has no target then targets player and sets agitation to 300
    ASF1_AVOIDPLAYERS           = 1 << 14, ///< NOT USED
    ASF1_FLOATINWATERONDEATH    = 1 << 15, ///< kAI will float up to the top of the water when they are dead
    ASF1_TELEPORT               = 1 << 16, ///< allows kAI to teleport on SetupAISpawnFlags
    ASF1_CASTSHADOW             = 1 << 17, ///< sets AF_CASTSHADOW on SetSpawnParams
    ASF1_TELEPORTWAIT           = 1 << 18, ///< allows enemy to move around for 1.5 - 4.5 seconds before teleporting back in.
    ASF1_USESTRONGATTACKS       = 1 << 19, ///< anim_aiMelee1
    ASF1_USEWEAKATTACKS         = 1 << 20, ///< anim_aiAltMelee1
    ASF1_SNIPER                 = 1 << 21,
    ASF1_MELTONDEATH            = 1 << 22, ///< allows melt effect and regeneration
    ASF1_AVOIDWATER             = 1 << 23, ///< sets AF_AVOIDWATER on SetSpawnParams
    ASF1_FLYING                 = 1 << 24, ///< NOT USED
    ASF1_TELEPORTAVOIDWATER     = 1 << 25,
    ASF1_TELEPORTAVOIDCLIFFS    = 1 << 26,
    ASF1_TRIGGERSTUFF           = 1 << 27, ///< Sets AF_TRIGGERSTUFF on SetupSpawnParams
    ASF1_CANNOTCAUSEAFIGHT      = 1 << 28, ///< if another actor was damaged by this actor with this flag set then other actor will not target this actor.
    ASF1_NOWALLCOLLISION        = 1 << 29, ///< NOT USED
    ASF1_SCREENSHAKE            = 1 << 30, ///< Used in floor mover scripts to shake screen.
    ASF1_RESPAWNANIMATION       = 1 << 31  ///< Enables respawning animation effect
};

◆ EnumActorSpawnFlags2

enum EnumActorSpawnFlags2

Enumerator
ASF2_DROPITEM_MASK1	1 << 0	Explosive shells.
ASF2_DROPITEM_MASK2	1 << 1	Grenade.
ASF2_DROPITEM_MASK3	1 << 2	Medium Health.
ASF2_DROPITEM_MASK4	1 << 3	Full Health.
ASF2_DROPITEM_MASK5	1 << 4	Ultra Health.
ASF2_DROPITEM_MASK6	1 << 5	Small Health.
ASF2_DROPITEM_MASK7	1 << 6	Large Health.
ASF2_DROPITEM_MASK8	1 << 7	Minigun ammo.
ASF2_DROPITEM_MASK9	1 << 8	Mortal Wound.
ASF2_DROPITEM_MASK10	1 << 9	4 Rockets
ASF2_DROPITEM_MASK11	1 << 10	Shotgun Shells.
ASF2_DROPITEM_MASK12	1 << 11	Energy Cell.
ASF2_DROPITEM_MASK13	1 << 12	Large Energy Cell.
ASF2_DROPITEM_MASK14	1 << 13	Clip.
ASF2_REMOVEONCOMPLETION	1 << 14	Sets AF_REMOVEONCOMPLETION.
ASF2_NOBLOOD	1 << 15
ASF2_HOLDTRIGGERANIMATION	1 << 16
ASF2_PROJECTILEATTACK3	1 << 17	crouch rifle Fire (anim_aiRangeAttack7)
ASF2_PROJECTILEATTACK4	1 << 18	(anim_aiRangeAttack8)
ASF2_DROPITEMONDAMAGE	1 << 19	NOT USED.
ASF2_NOAUTOMAPDRAW	1 << 20	if map all or show enemies cheats are on then will not draw this actor on the automap.
ASF2_ALTERNATEMOVES	1 << 21	is for holding two handed weapons
ASF2_UNUSED1	1 << 22	NOT USED.
ASF2_UNUSED2	1 << 23	NOT USED.
ASF2_PROJECTILEATTACK5	1 << 24	Stand Rifle Fire (anim_aiRangeAttack5)
ASF2_PROJECTILEATTACK6	1 << 25	Pipe Blow (anim_aiRangeAttack6)
ASF2_MORTALWOUNDIMPACT	1 << 26	Can be hit by a super arrow shot and if ASF2_DROPITEM_MASK9 is on has a chance to drop a mortal wound.
ASF2_STAYINWATER	1 << 27	sets AF_STAYINWATER on SetSpawnParams
ASF2_WARPDEATH	1 << 28	NOT USED.
ASF2_STOREWARPRETURN	1 << 29	Used in portal scripts.
ASF2_PROJECTILEATTACK7	1 << 30	Grenade Throw (anim_aiRangeAttack3)
ASF2_PROJECTILEATTACK8	1 << 31	High Priest Homing Blue Flame (anim_aiRangeAttack4)

Definition at line 108 of file t1_scriptAPI.cpp.

{
    ASF2_DROPITEM_MASK1         = 1 << 0,  ///< Explosive shells
    ASF2_DROPITEM_MASK2         = 1 << 1,  ///< Grenade
    ASF2_DROPITEM_MASK3         = 1 << 2,  ///< Medium Health
    ASF2_DROPITEM_MASK4         = 1 << 3,  ///< Full Health
    ASF2_DROPITEM_MASK5         = 1 << 4,  ///< Ultra Health
    ASF2_DROPITEM_MASK6         = 1 << 5,  ///< Small Health
    ASF2_DROPITEM_MASK7         = 1 << 6,  ///< Large Health
    ASF2_DROPITEM_MASK8         = 1 << 7,  ///< Minigun ammo
    ASF2_DROPITEM_MASK9         = 1 << 8,  ///< Mortal Wound
    ASF2_DROPITEM_MASK10        = 1 << 9,  ///< 4 Rockets
    ASF2_DROPITEM_MASK11        = 1 << 10, ///< Shotgun Shells
    ASF2_DROPITEM_MASK12        = 1 << 11, ///< Energy Cell
    ASF2_DROPITEM_MASK13        = 1 << 12, ///< Large Energy Cell
    ASF2_DROPITEM_MASK14        = 1 << 13, ///< Clip
    ASF2_REMOVEONCOMPLETION     = 1 << 14, ///< Sets AF_REMOVEONCOMPLETION
    ASF2_NOBLOOD                = 1 << 15,
    ASF2_HOLDTRIGGERANIMATION   = 1 << 16,
    ASF2_PROJECTILEATTACK3      = 1 << 17, ///< crouch rifle Fire (anim_aiRangeAttack7)
    ASF2_PROJECTILEATTACK4      = 1 << 18, ///< (anim_aiRangeAttack8)
    ASF2_DROPITEMONDAMAGE       = 1 << 19, ///< NOT USED
    ASF2_NOAUTOMAPDRAW          = 1 << 20, ///< if map all or show enemies cheats are on then will not draw this actor on the automap.
    ASF2_ALTERNATEMOVES         = 1 << 21, ///< is for holding two handed weapons
    ASF2_UNUSED1                = 1 << 22, ///< NOT USED
    ASF2_UNUSED2                = 1 << 23, ///< NOT USED
    ASF2_PROJECTILEATTACK5      = 1 << 24, ///< Stand Rifle Fire (anim_aiRangeAttack5)
    ASF2_PROJECTILEATTACK6      = 1 << 25, ///< Pipe Blow (anim_aiRangeAttack6)
    ASF2_MORTALWOUNDIMPACT      = 1 << 26, ///< Can be hit by a super arrow shot and if ASF2_DROPITEM_MASK9 is on has a chance to drop a mortal wound
    ASF2_STAYINWATER            = 1 << 27, ///< sets AF_STAYINWATER on SetSpawnParams
    ASF2_WARPDEATH              = 1 << 28, ///< NOT USED
    ASF2_STOREWARPRETURN        = 1 << 29, ///< Used in portal scripts
    ASF2_PROJECTILEATTACK7      = 1 << 30, ///< Grenade Throw (anim_aiRangeAttack3)
    ASF2_PROJECTILEATTACK8      = 1 << 31  ///< High Priest Homing Blue Flame (anim_aiRangeAttack4)
};

◆ EnumActorSpawnFlags3

enum EnumActorSpawnFlags3

Enumerator
ASF3_RETURNWARP	1 << 0	Used in portal scripts.
ASF3_PLAYTRIGGERANIMONCE	1 << 1	MarkPersistentBit(false) when activated.
ASF3_REGENERATEFROMSTART	1 << 2	Regen from starting position.
ASF3_WALKINSTRAIGHTLINE	1 << 3	Set animation to Blend(ANIM_WALKING, (m_animSpeed * m_animScalar), 10, ANF_LOOP\|ANF_ROOTMOTION); and do nothing else.
ASF3_KILLOUTSIDEOFVIEW	1 << 4	NOT USED.
ASF3_NOTHINKER	1 << 5	AI will not function. Actors will not update movement. Actors OnBeginLevel will set their animation to ANIM_SPECIAL_EVENT.
ASF3_AVOIDPLAYERS2	1 << 6	NOT USED.
ASF3_NOVIOLENTDEATH	1 << 7	ANIM_AIDEATHSTAND and ANIM_DEATHSTANDALT will not play when kAI is killed.
ASF3_PROJECTILEATTACK9	1 << 8	Demon chest Hadoken (anim_aiRangeAttack9)
ASF3_PROJECTILEATTACK10	1 << 9	High Priest Lightning Red Flames (anim_aiRangeAttack10)
ASF3_MAKESPAWNANIMVISIBLE	1 << 10	clears actor flags: ~(AF_HIDDEN\|AF_DISABLED)
ASF3_NODRAWONCAMERA	1 << 11	Will not draw this actor when viewing from camera unless camera flags has CMF_SHOW_HIDDEN_OBJECTS.

Definition at line 144 of file t1_scriptAPI.cpp.

{
    ASF3_RETURNWARP             = 1 << 0,  ///< Used in portal scripts
    ASF3_PLAYTRIGGERANIMONCE    = 1 << 1,  ///< MarkPersistentBit(false) when activated
    ASF3_REGENERATEFROMSTART    = 1 << 2,  ///< Regen from starting position
    ASF3_WALKINSTRAIGHTLINE     = 1 << 3,  ///< Set animation to Blend(ANIM_WALKING, (m_animSpeed * m_animScalar), 10, ANF_LOOP|ANF_ROOTMOTION); and do nothing else.
    ASF3_KILLOUTSIDEOFVIEW      = 1 << 4,  ///< NOT USED
    ASF3_NOTHINKER              = 1 << 5,  ///< AI will not function. Actors will not update movement. Actors OnBeginLevel will set their animation to ANIM_SPECIAL_EVENT.
    ASF3_AVOIDPLAYERS2          = 1 << 6,  ///< NOT USED
    ASF3_NOVIOLENTDEATH         = 1 << 7,  ///< ANIM_AIDEATHSTAND and ANIM_DEATHSTANDALT will not play when kAI is killed.
    ASF3_PROJECTILEATTACK9      = 1 << 8,  ///< Demon chest Hadoken (anim_aiRangeAttack9)
    ASF3_PROJECTILEATTACK10     = 1 << 9,  ///< High Priest Lightning Red Flames (anim_aiRangeAttack10)
    ASF3_MAKESPAWNANIMVISIBLE   = 1 << 10, ///< clears actor flags: ~(AF_HIDDEN|AF_DISABLED)
    ASF3_NODRAWONCAMERA         = 1 << 11  ///< Will not draw this actor when viewing from camera unless camera flags has CMF_SHOW_HIDDEN_OBJECTS.
};

◆ EnumAIFlags

enum EnumAIFlags

Enumerator
AIF_ATTACKING	1 << 0	playing an attacking animation
AIF_WASSOLID	1 << 1
AIF_FIRSTATTACK	1 << 2
AIF_HEARDLOUDNOISE	1 << 3
AIF_BLOWNAWAY	1 << 4	being blown away by explosion
AIF_GOBACKTOLEASH	1 << 5
AIF_RESSURECT	1 << 6
AIF_FEIGNDEATH	1 << 7
AIF_REGENERATE	1 << 8
AIF_SEETARGET	1 << 9
AIF_NOCHASE	1 << 10	disable chase logic
AIF_REGENERATEANIM	1 << 11
AIF_NOTHINK	1 << 12	don't run ai logic
AIF_RUNNING	1 << 13	Is playing running animation.
AIF_GETATTENTION	1 << 14
AIF_REGENANIMDELAY	1 << 15
AIF_HEARDQUIETNOISE	1 << 16
AIF_AWAYFROMLEASH	1 << 17
AIF_TELEPORTAWAY	1 << 18	playing teleport out animation
AIF_TELEPORTMOVESLOW	1 << 19	chasing while underground
AIF_TELEPORTING	1 << 20	in teleport state. ignore all chase logic
AIF_TELEPORTIN	1 << 21	playing teleport in animation
AIF_WAITFORCYCLE	1 << 22	prevent other animations from interrupting until the current one finishes
AIF_DAMAGEPANIC	1 << 23	become aggressive when target is outside its active threshold (good for forcing AI to attack their target)

Definition at line 208 of file t1_scriptAPI.cpp.

{
    AIF_ATTACKING           = 1 << 0,  ///< playing an attacking animation
    AIF_WASSOLID            = 1 << 1,
    AIF_FIRSTATTACK         = 1 << 2,
    AIF_HEARDLOUDNOISE      = 1 << 3,
    AIF_BLOWNAWAY           = 1 << 4,  ///< being blown away by explosion
    AIF_GOBACKTOLEASH       = 1 << 5,
    AIF_RESSURECT           = 1 << 6,
    AIF_FEIGNDEATH          = 1 << 7,
    AIF_REGENERATE          = 1 << 8,
    AIF_SEETARGET           = 1 << 9,
    AIF_NOCHASE             = 1 << 10, ///< disable chase logic
    AIF_REGENERATEANIM      = 1 << 11,
    AIF_NOTHINK             = 1 << 12, ///< don't run ai logic
    AIF_RUNNING             = 1 << 13, ///< Is playing running animation
    AIF_GETATTENTION        = 1 << 14,
    AIF_REGENANIMDELAY      = 1 << 15,
    AIF_HEARDQUIETNOISE     = 1 << 16,
    AIF_AWAYFROMLEASH       = 1 << 17,
    AIF_TELEPORTAWAY        = 1 << 18, ///< playing teleport out animation
    AIF_TELEPORTMOVESLOW    = 1 << 19, ///< chasing while underground
    AIF_TELEPORTING         = 1 << 20, ///< in teleport state. ignore all chase logic
    AIF_TELEPORTIN          = 1 << 21, ///< playing teleport in animation
    AIF_WAITFORCYCLE        = 1 << 22, ///< prevent other animations from interrupting until the current one finishes
    AIF_DAMAGEPANIC         = 1 << 23  ///< become aggressive when target is outside its active threshold (good for forcing AI to attack their target)
};

◆ EnumAnimStateFlags

enum EnumAnimStateFlags

Enumerator
ANF_BLEND	1 << 0
ANF_LOOP	1 << 1
ANF_STOPPED	1 << 2
ANF_NOINTERRUPT	1 << 3
ANF_ROOTMOTION	1 << 4
ANF_PAUSED	1 << 5
ANF_CYCLECOMPLETED	1 << 6
ANF_LINEARBLEND	1 << 7

Definition at line 24 of file t1_scriptAPI.cpp.

{
    ANF_BLEND           = 1 << 0,
    ANF_LOOP            = 1 << 1,
    ANF_STOPPED         = 1 << 2,
    ANF_NOINTERRUPT     = 1 << 3,
    ANF_ROOTMOTION      = 1 << 4,
    ANF_PAUSED          = 1 << 5,
    ANF_CYCLECOMPLETED  = 1 << 6,
    ANF_LINEARBLEND     = 1 << 7
};

◆ EnumAreaFlags

enum EnumAreaFlags

Enumerator
AAF_WATER	1 << 0
AAF_BLOCK	1 << 1
AAF_TOGGLE	1 << 2	if on and AAF_BLOCK is on then sectors won't be marked on automap until it's unblocked. Used for door areas.
AAF_CLIFF	1 << 3	is a wall
AAF_CLIMB	1 << 4	climb up sectors faster than AAF_LADDER
AAF_ONESIDED	1 << 5	Bridge.
AAF_CEILING	1 << 6
AAF_CRAWL	1 << 7
AAF_ENTERCRAWL	1 << 8	Exactly the same as AAF_CRAWL except actors won't collide with this sector when CF_ALLOWCRAWL is not set.
AAF_HIDDEN	1 << 9
AAF_ENTERED	1 << 10	Not shown in Editor. Used in kex editor only for fill sector commands. When map is saved in kex editor all sectors will have this flag off.
AAF_SECRET	1 << 11
AAF_RESTRICTED	1 << 12	kAI can't enter the area
AAF_SLOPETEST	1 << 13	overrides AAF_CLIFF flag. If the sectors floor plane up direction is <= 0.5 then is a wall (a wall is the same as the AAF_CLIFF flag).
AAF_DEATHPIT	1 << 14
AAF_MAPPED	1 << 15
AAF_EVENT	1 << 16
AAF_REPEATABLE	1 << 17	Unused. In the original game this is used in combination with AAF_EVENT and will only trigger the event if the actor has also collided with a wall.
AAF_TELEPORT	1 << 18
AAF_DAMAGE	1 << 19
AAF_DRAWSKY	1 << 20
AAF_TELEPORTAIR	1 << 21
AAF_LAVA	1 << 22
AAF_EVENTSOUND	1 << 23
AAF_ANTIGRAVITY	1 << 24
AAF_LADDER	1 << 25	climb up sectors slower than AAF_CLIMB
AAF_CHECKPOINT	1 << 26
AAF_SAVEGAME	1 << 27
AAF_WARPRETURN	1 << 28	In Remaster it's used as a PlayerBlocking sector. used with clipflag CF_COLLIDEPLAYERBLOCKER.
AAF_SHALLOWWATER	1 << 29
AAF_DRAWSUN	1 << 30
AAF_STOREWARPRETURN	1 << 31	Unused.

Definition at line 448 of file t1_scriptAPI.cpp.

{
    AAF_WATER           = 1 << 0,
    AAF_BLOCK           = 1 << 1,
    AAF_TOGGLE          = 1 << 2,  ///< if on and AAF_BLOCK is on then sectors won't be marked on automap until it's unblocked. Used for door areas.
    AAF_CLIFF           = 1 << 3,  ///< is a wall
    AAF_CLIMB           = 1 << 4,  ///< climb up sectors faster than AAF_LADDER
    AAF_ONESIDED        = 1 << 5,  ///< Bridge
    AAF_CEILING         = 1 << 6,
    AAF_CRAWL           = 1 << 7,
    AAF_ENTERCRAWL      = 1 << 8,  ///< Exactly the same as AAF_CRAWL except actors won't collide with this sector when CF_ALLOWCRAWL is not set.
    AAF_HIDDEN          = 1 << 9,
    AAF_ENTERED         = 1 << 10, ///< Not shown in Editor. Used in kex editor only for fill sector commands. When map is saved in kex editor all sectors will have this flag off.
    AAF_SECRET          = 1 << 11,
    AAF_RESTRICTED      = 1 << 12, ///< kAI can't enter the area
    AAF_SLOPETEST       = 1 << 13, ///< overrides AAF_CLIFF flag. If the sectors floor plane up direction is <= 0.5 then is a wall (a wall is the same as the AAF_CLIFF flag).
    AAF_DEATHPIT        = 1 << 14,
    AAF_MAPPED          = 1 << 15,
    AAF_EVENT           = 1 << 16,
    AAF_REPEATABLE      = 1 << 17, ///< Unused. In the original game this is used in combination with AAF_EVENT and will only trigger the event if the actor has also collided with a wall.
    AAF_TELEPORT        = 1 << 18,
    AAF_DAMAGE          = 1 << 19,
    AAF_DRAWSKY         = 1 << 20,
    AAF_TELEPORTAIR     = 1 << 21,
    AAF_LAVA            = 1 << 22,
    AAF_EVENTSOUND      = 1 << 23,
    AAF_ANTIGRAVITY     = 1 << 24,
    AAF_LADDER          = 1 << 25, ///< climb up sectors slower than AAF_CLIMB
    AAF_CHECKPOINT      = 1 << 26,
    AAF_SAVEGAME        = 1 << 27,
    AAF_WARPRETURN      = 1 << 28, ///< In Remaster it's used as a PlayerBlocking sector. used with clipflag CF_COLLIDEPLAYERBLOCKER.
    AAF_SHALLOWWATER    = 1 << 29,
    AAF_DRAWSUN         = 1 << 30,
    AAF_STOREWARPRETURN = 1 << 31  ///< Unused
};

◆ EnumCameraFlags

enum EnumCameraFlags

Enumerator
CMF_NO_INITIAL_FADEOUT	1 << 0
CMF_NO_LETTERBOX	1 << 1
CMF_LOCK_PLAYER	1 << 2
CMF_UNLOCK_PLAYER_ON_FINISH	1 << 3
CMF_INITIAL_FADEIN	1 << 4
CMF_SHOW_CREDITS	1 << 5
CMF_CHANGE_MAP_AFTER_FADE	1 << 6
CMF_SHOW_HIDDEN_OBJECTS	1 << 7
CMF_NO_INITIAL_FADEIN	1 << 8
CMF_NO_SUNLENSFLARE	1 << 9	Doesn't force the sun lens flare always on. Sun lens flare will work normally, using the "Always Show Lens Flares" option and checking if the sun is being blocked.

Definition at line 423 of file t1_scriptAPI.cpp.

{
    CMF_NO_INITIAL_FADEOUT      = 1 << 0,
    CMF_NO_LETTERBOX            = 1 << 1,
    CMF_LOCK_PLAYER             = 1 << 2,
    CMF_UNLOCK_PLAYER_ON_FINISH = 1 << 3,
    CMF_INITIAL_FADEIN          = 1 << 4,
    CMF_SHOW_CREDITS            = 1 << 5,
    CMF_CHANGE_MAP_AFTER_FADE   = 1 << 6,
    CMF_SHOW_HIDDEN_OBJECTS     = 1 << 7,
    CMF_NO_INITIAL_FADEIN       = 1 << 8,
    CMF_NO_SUNLENSFLARE         = 1 << 9  ///< Doesn't force the sun lens flare always on. Sun lens flare will work normally, using the "Always Show Lens Flares" option and checking if the sun is being blocked.
};

◆ EnumCameraLerpType

enum EnumCameraLerpType

Lerp type when doing AutoPlayPositionTrack, AutoPlayRotationTrack, or AutoPlayBlendTrack. When a view has one of those active the view's time variable is then increased by GAME_DELTA_TIME.

Enumerator
CMLT_NONE	0	time is set to time / speed.
CMLT_LINEAR	1	time is set to time / speed.
CMLT_LINEARLOOP	2	time is set to time / speed. If time is > 1.0 then time -= 1.0
CMLT_COSINE	3	time will never be higher than speed. time = CosTween(time * (1.0f / speed));
CMLT_COSINE_POW	4	time will never be higher than speed. time = CosTween(Pow(time * (1.0f / speed), 3));

Definition at line 414 of file t1_scriptAPI.cpp.

{
    CMLT_NONE       = 0, ///< time is set to time / speed.
    CMLT_LINEAR     = 1, ///< time is set to time / speed.
    CMLT_LINEARLOOP = 2, ///< time is set to time / speed. If time is > 1.0 then time -= 1.0
    CMLT_COSINE     = 3, ///< time will never be higher than speed. time = CosTween(time * (1.0f / speed));
    CMLT_COSINE_POW = 4  ///< time will never be higher than speed. time = CosTween(Pow(time * (1.0f / speed), 3));
};

◆ EnumCameraStates

enum EnumCameraStates

Enumerator
CAMS_IDLE	0
CAMS_FADEOUT	1
CAMS_FADEIN	2
CAMS_ACTIVE	3
CAMS_ACTIVE_TO_FADEOUT	4
CAMS_FADEBACK_TO_CLIENT	5
CAMS_RESTORE_TO_CLIENT	6

Definition at line 437 of file t1_scriptAPI.cpp.

{
    CAMS_IDLE               = 0,
    CAMS_FADEOUT            = 1,
    CAMS_FADEIN             = 2,
    CAMS_ACTIVE             = 3,
    CAMS_ACTIVE_TO_FADEOUT  = 4,
    CAMS_FADEBACK_TO_CLIENT = 5,
    CAMS_RESTORE_TO_CLIENT  = 6
};

◆ EnumCheatFlags

enum EnumCheatFlags

Enumerator
GC_BIG_HEADS	1 << 0
GC_TINY_ENEMY	1 << 1
GC_INFINITE_AMMO	1 << 2
GC_PURDY_COLORS	1 << 3
GC_SPIRIT_MODE	1 << 4
GC_INVINCIBILITY	1 << 5
GC_FLIGHT	1 << 6
GC_DISCO	1 << 7
GC_INFINITE_LIVES	1 << 8
GC_ALL_MAP	1 << 9
GC_SHOW_ENEMIES	1 << 10
GC_NOCLIP	1 << 11

Definition at line 192 of file t1_scriptAPI.cpp.

{
    GC_BIG_HEADS        = 1 << 0,
    GC_TINY_ENEMY       = 1 << 1,
    GC_INFINITE_AMMO    = 1 << 2,
    GC_PURDY_COLORS     = 1 << 3,
    GC_SPIRIT_MODE      = 1 << 4,
    GC_INVINCIBILITY    = 1 << 5,
    GC_FLIGHT           = 1 << 6,
    GC_DISCO            = 1 << 7,
    GC_INFINITE_LIVES   = 1 << 8,
    GC_ALL_MAP          = 1 << 9,
    GC_SHOW_ENEMIES     = 1 << 10,
    GC_NOCLIP           = 1 << 11,
};

◆ EnumClipFlags

enum EnumClipFlags

Enumerator
CF_CLIPEDGES	1 << 0	clip movement against edges that don't link to sectors
CF_IGNOREBLOCKERS	1 << 1	don't clip edges belonging to blocking sectors
CF_DROPOFF	1 << 2	allows passing through platforms or ledges
CF_NOENTERWATER	1 << 3	block all edges that links to a water sector
CF_NOEXITWATER	1 << 4	block all edges that links to a non-water sector
CF_NOCLIPSTATICS	1 << 5	don't collide with static models
CF_NOCLIPACTORS	1 << 6	don't collide with dynamic objects/actors
CF_WALKWALLS	1 << 7	don't restrict movement to steep slopes
CF_COLLIDEFLOORS	1 << 8	project and clip movement against non-flat floors
CF_HITSCAN	1 << 9	performs a single-pass trace. useful for hitscans
CF_ALLOWCLIMB	1 << 10	collide with sectors flagged as climbable
CF_ALLOWCRAWL	1 << 11	collide with sectors flagged as crawlable
CF_NOSTEPDOWN	1 << 12	don't clamp z-axis when walking down slopes
CF_NOSLOPESTEP	1 << 13	don't project z-axis movement along slopes
CF_COLLIDEHEIGHT	1 << 14	clip against ceilings
CF_COLLIDECORPSES	1 << 15	clip against actors flagged as dead
CF_NOEXITWALLS	1 << 16	clip all edges, regardless if they link to another sector or not
CF_NOCOLLIDEFUNC	1 << 17	don't invoke the OnCollide callback on the moving object
CF_NOFLOORADJUST	1 << 18	don't keep z-axis above floor plane
CF_NOCEILINGADJUST	1 << 19	don't keep z-axis below ceiling plane
CF_COLLIDEWATER	1 << 20	clip movement against the water surface
CF_USEWALLRADIUS	1 << 21	clip and project movement away from walls based on wall radius
CF_NOCLIPTARGETACTORS	1 << 22	don't clip actors that are targeted by moving object
CF_COLLIDETRIGGERS	1 << 23	block edges belonging to a trigger. Can't cross into sectors if sector has AAF_EVENT.
CF_STANDONOBJECTS	1 << 24	allow vertical clipping of objects
CF_GREASESLIDEOBJECTS	1 << 25	always keep movement projected away from collided objects
CF_ALLOWRESTRICTEDAREAS	1 << 26	don't collide with edges belonging to a restricted sector
CF_COLLIDECLIFFS	1 << 27	collide with non-walkable floors
CF_CHECKLINKEDBRIDGES	1 << 28	do extensive checks against overlapping bridge sectors
CF_POLYCOLLISION	1 << 29	clip movement against all model polygons of an object
CF_COLLIDEPLAYERBLOCKER	1 << 30	collide with edges linked to player blocking regions (AAF_WARPRETURN)

Definition at line 367 of file t1_scriptAPI.cpp.

{
    CF_CLIPEDGES            = 1 << 0,  ///< clip movement against edges that don't link to sectors
    CF_IGNOREBLOCKERS       = 1 << 1,  ///< don't clip edges belonging to blocking sectors
    CF_DROPOFF              = 1 << 2,  ///< allows passing through platforms or ledges
    CF_NOENTERWATER         = 1 << 3,  ///< block all edges that links to a water sector
    CF_NOEXITWATER          = 1 << 4,  ///< block all edges that links to a non-water sector
    CF_NOCLIPSTATICS        = 1 << 5,  ///< don't collide with static models
    CF_NOCLIPACTORS         = 1 << 6,  ///< don't collide with dynamic objects/actors
    CF_WALKWALLS            = 1 << 7,  ///< don't restrict movement to steep slopes
    CF_COLLIDEFLOORS        = 1 << 8,  ///< project and clip movement against non-flat floors
    CF_HITSCAN              = 1 << 9,  ///< performs a single-pass trace. useful for hitscans
    CF_ALLOWCLIMB           = 1 << 10, ///< collide with sectors flagged as climbable
    CF_ALLOWCRAWL           = 1 << 11, ///< collide with sectors flagged as crawlable
    CF_NOSTEPDOWN           = 1 << 12, ///< don't clamp z-axis when walking down slopes
    CF_NOSLOPESTEP          = 1 << 13, ///< don't project z-axis movement along slopes
    CF_COLLIDEHEIGHT        = 1 << 14, ///< clip against ceilings
    CF_COLLIDECORPSES       = 1 << 15, ///< clip against actors flagged as dead
    CF_NOEXITWALLS          = 1 << 16, ///< clip all edges, regardless if they link to another sector or not
    CF_NOCOLLIDEFUNC        = 1 << 17, ///< don't invoke the OnCollide callback on the moving object
    CF_NOFLOORADJUST        = 1 << 18, ///< don't keep z-axis above floor plane
    CF_NOCEILINGADJUST      = 1 << 19, ///< don't keep z-axis below ceiling plane
    CF_COLLIDEWATER         = 1 << 20, ///< clip movement against the water surface
    CF_USEWALLRADIUS        = 1 << 21, ///< clip and project movement away from walls based on wall radius
    CF_NOCLIPTARGETACTORS   = 1 << 22, ///< don't clip actors that are targeted by moving object
    CF_COLLIDETRIGGERS      = 1 << 23, ///< block edges belonging to a trigger. Can't cross into sectors if sector has AAF_EVENT.
    CF_STANDONOBJECTS       = 1 << 24, ///< allow vertical clipping of objects
    CF_GREASESLIDEOBJECTS   = 1 << 25, ///< always keep movement projected away from collided objects
    CF_ALLOWRESTRICTEDAREAS = 1 << 26, ///< don't collide with edges belonging to a restricted sector
    CF_COLLIDECLIFFS        = 1 << 27, ///< collide with non-walkable floors
    CF_CHECKLINKEDBRIDGES   = 1 << 28, ///< do extensive checks against overlapping bridge sectors
    CF_POLYCOLLISION        = 1 << 29, ///< clip movement against all model polygons of an object
    CF_COLLIDEPLAYERBLOCKER = 1 << 30  ///< collide with edges linked to player blocking regions (AAF_WARPRETURN)
};

◆ EnumClipResultFlags

enum EnumClipResultFlags

Enumerator
CRF_NOCOLLISION	0
CRF_FLOOR	1 << 0	made contact with a floor
CRF_CEILING	1 << 1	made contact with a ceiling
CRF_WALL	1 << 2	made contact with an edge (sector edge that isn't linked to another sector)
CRF_OBJECT	1 << 3	made contact with an actor
CRF_MESH	1 << 4	made contact with a static object
CRF_ADJUST	1 << 5	z-axis was adjusted (ceiling or floor)
CRF_WALLRADIUS	1 << 6	made contact with an edge during the wall radius collision test

Definition at line 258 of file t1_scriptAPI.cpp.

{
    CRF_NOCOLLISION = 0,
    CRF_FLOOR       = 1 << 0, ///< made contact with a floor
    CRF_CEILING     = 1 << 1, ///< made contact with a ceiling
    CRF_WALL        = 1 << 2, ///< made contact with an edge (sector edge that isn't linked to another sector)
    CRF_OBJECT      = 1 << 3, ///< made contact with an actor
    CRF_MESH        = 1 << 4, ///< made contact with a static object
    CRF_ADJUST      = 1 << 5, ///< z-axis was adjusted (ceiling or floor)
    CRF_WALLRADIUS  = 1 << 6  ///< made contact with an edge during the wall radius collision test
};

◆ EnumCustomHUDFlags

enum EnumCustomHUDFlags

Enumerator
CHF_HIDECINEMA	1 << 0	Hide when cinema is active.
CHF_HIDEMENU	1 << 1	Hide when menu is active.
CHF_HIDEDUMMYMENU	1 << 2	Hide when dummy menu is active.
CHF_HIDENOHUD	1 << 3	Hide when Show HUD menu option is off.
CHF_ALPHASCALE	1 << 4	Scales color alpha values by the HUD opacity menu option.

Definition at line 500 of file t1_scriptAPI.cpp.

{
    CHF_HIDECINEMA    = 1 << 0, ///< Hide when cinema is active
    CHF_HIDEMENU      = 1 << 1, ///< Hide when menu is active
    CHF_HIDEDUMMYMENU = 1 << 2, ///< Hide when dummy menu is active
    CHF_HIDENOHUD     = 1 << 3, ///< Hide when Show HUD menu option is off
    CHF_ALPHASCALE    = 1 << 4  ///< Scales color alpha values by the HUD opacity menu option
};

◆ EnumDifficulty

enum EnumDifficulty

Enumerator
DIFFICULTY_EASY	0
DIFFICULTY_NORMAL	1
DIFFICULTY_HARD	2
DIFFICULTY_HARDCORE	3

Definition at line 359 of file t1_scriptAPI.cpp.

{
    DIFFICULTY_EASY     = 0,
    DIFFICULTY_NORMAL   = 1,
    DIFFICULTY_HARD     = 2,
    DIFFICULTY_HARDCORE = 3
};

◆ EnumGameButtonEvents

enum EnumGameButtonEvents

Enumerator
GBE_MENU_UP	1 << 0
GBE_MENU_RIGHT	1 << 1
GBE_MENU_DOWN	1 << 2
GBE_MENU_LEFT	1 << 3
GBE_MENU_SELECT	1 << 4
GBE_MENU_CANCEL	1 << 5
GBE_MENU_BACK	1 << 6
GBE_MENU_ACTIVATE	1 << 7
GBE_MENU_DESELECT	1 << 8
GBE_MENU_MOUSESELECT	1 << 9

Definition at line 345 of file t1_scriptAPI.cpp.

{
    GBE_MENU_UP             = 1 << 0,
    GBE_MENU_RIGHT          = 1 << 1,
    GBE_MENU_DOWN           = 1 << 2,
    GBE_MENU_LEFT           = 1 << 3,
    GBE_MENU_SELECT         = 1 << 4,
    GBE_MENU_CANCEL         = 1 << 5,
    GBE_MENU_BACK           = 1 << 6,
    GBE_MENU_ACTIVATE       = 1 << 7,
    GBE_MENU_DESELECT       = 1 << 8,
    GBE_MENU_MOUSESELECT    = 1 << 9
};

◆ EnumGameFontType

enum EnumGameFontType

Enumerator
GFT_BIG	0
GFT_SMALL	1
GFT_NUMBERS	2
GFT_TTF	3

Definition at line 250 of file t1_scriptAPI.cpp.

{
    GFT_BIG     = 0,
    GFT_SMALL   = 1,
    GFT_NUMBERS = 2,
    GFT_TTF     = 3
};

◆ EnumImpactType

enum EnumImpactType

Enumerator
IT_DEFAULT	0
IT_WATER	1
IT_METAL	2
IT_STONE	3
IT_FLESH_HUMAN	4
IT_FLESH_CREATURE	5
IT_FLESH_UNDEAD	6	AKA IT_FLESH_WATER. Not used in the remaster for anything by default. In the original game if an Fx was underwater and hit an actor that had an impact type of IT_FLESH_HUMAN or IT_FLESH_CREATURE it would do a IT_FLESH_UNDEAD impact instead.
IT_LAVA	7
IT_SLIME	8
IT_FORCEFIELD	9

Definition at line 236 of file t1_scriptAPI.cpp.

{
    IT_DEFAULT          = 0,
    IT_WATER            = 1,
    IT_METAL            = 2,
    IT_STONE            = 3,
    IT_FLESH_HUMAN      = 4,
    IT_FLESH_CREATURE   = 5,
    IT_FLESH_UNDEAD     = 6, ///< AKA IT_FLESH_WATER. Not used in the remaster for anything by default. In the original game if an Fx was underwater and hit an actor that had an impact type of IT_FLESH_HUMAN or IT_FLESH_CREATURE it would do a IT_FLESH_UNDEAD impact instead.
    IT_LAVA             = 7,
    IT_SLIME            = 8,
    IT_FORCEFIELD       = 9
};

◆ EnumInputActions

enum EnumInputActions

Enumerator
IA_ATTACK	0
IA_JUMP	1
IA_FORWARD	2
IA_BACKWARD	3
IA_STRAFELEFT	4
IA_STRAFERIGHT	5
IA_WEAPNEXT	6
IA_WEAPPREV	7
IA_MAPZOOMIN	8
IA_MAPZOOMOUT	9
IA_CUSTOM1	10
IA_CUSTOM2	11

Definition at line 283 of file t1_scriptAPI.cpp.

{
    IA_ATTACK       = 0,
    IA_JUMP         = 1,
    IA_FORWARD      = 2,
    IA_BACKWARD     = 3,
    IA_STRAFELEFT   = 4,
    IA_STRAFERIGHT  = 5,
    IA_WEAPNEXT     = 6,
    IA_WEAPPREV     = 7,
    IA_MAPZOOMIN    = 8,
    IA_MAPZOOMOUT   = 9,
    IA_CUSTOM1      = 10,
    IA_CUSTOM2      = 11
};

◆ EnumPlaneSide

enum EnumPlaneSide

Enumerator
PSIDE_FRONT	0
PSIDE_BACK	1
PSIDE_ON	2

Definition at line 1 of file t1_scriptAPI.cpp.

{
    PSIDE_FRONT = 0,
    PSIDE_BACK  = 1,
    PSIDE_ON    = 2
};

◆ EnumPlayerButtons

enum EnumPlayerButtons

Enumerator
BC_ATTACK	1 << 0
BC_JUMP	1 << 1
BC_FORWARD	1 << 2
BC_BACKWARD	1 << 3
BC_STRAFELEFT	1 << 4
BC_STRAFERIGHT	1 << 5
BC_WEAPONRIGHT	1 << 6
BC_WEAPONLEFT	1 << 7
BC_MAPZOOMIN	1 << 8
BC_MAPZOOMOUT	1 << 9
BC_CUSTOM1	1 << 10
BC_CUSTOM2	1 << 11

Definition at line 299 of file t1_scriptAPI.cpp.

{
    BC_ATTACK       = 1 << 0,
    BC_JUMP         = 1 << 1,
    BC_FORWARD      = 1 << 2,
    BC_BACKWARD     = 1 << 3,
    BC_STRAFELEFT   = 1 << 4,
    BC_STRAFERIGHT  = 1 << 5,
    BC_WEAPONRIGHT  = 1 << 6,
    BC_WEAPONLEFT   = 1 << 7,
    BC_MAPZOOMIN    = 1 << 8,
    BC_MAPZOOMOUT   = 1 << 9,
    BC_CUSTOM1      = 1 << 10,
    BC_CUSTOM2      = 1 << 11
};

◆ EnumPlayerConButtons

enum EnumPlayerConButtons

Enumerator
CBC_WEAPON1	1 << 0
CBC_WEAPON2	1 << 1
CBC_WEAPON3	1 << 2
CBC_WEAPON4	1 << 3
CBC_WEAPON5	1 << 4
CBC_WEAPON6	1 << 5
CBC_WEAPON7	1 << 6
CBC_WEAPON8	1 << 7
CBC_WEAPON9	1 << 8
CBC_WEAPON10	1 << 9
CBC_WEAPON11	1 << 10
CBC_WEAPON12	1 << 11
CBC_WEAPON13	1 << 12
CBC_WEAPON14	1 << 13
CBC_AUTOMAP	1 << 14
CBC_CHANGEAMMO	1 << 15
CBC_RUNWALK	1 << 16
CBC_MENUUP	1 << 17
CBC_MENUDOWN	1 << 18
CBC_MENULEFT	1 << 19
CBC_MENURIGHT	1 << 20
CBC_MENUSELECT	1 << 21
CBC_MENUDESELECT	1 << 22
CBC_MENUBACK	1 << 23
CBC_MENUCANCEL	1 << 24
CBC_MENUACTIVATE	1 << 25

Definition at line 315 of file t1_scriptAPI.cpp.

{
    CBC_WEAPON1         = 1 << 0,
    CBC_WEAPON2         = 1 << 1,
    CBC_WEAPON3         = 1 << 2,
    CBC_WEAPON4         = 1 << 3,
    CBC_WEAPON5         = 1 << 4,
    CBC_WEAPON6         = 1 << 5,
    CBC_WEAPON7         = 1 << 6,
    CBC_WEAPON8         = 1 << 7,
    CBC_WEAPON9         = 1 << 8,
    CBC_WEAPON10        = 1 << 9,
    CBC_WEAPON11        = 1 << 10,
    CBC_WEAPON12        = 1 << 11,
    CBC_WEAPON13        = 1 << 12,
    CBC_WEAPON14        = 1 << 13,
    CBC_AUTOMAP         = 1 << 14,
    CBC_CHANGEAMMO      = 1 << 15,
    CBC_RUNWALK         = 1 << 16,
    CBC_MENUUP          = 1 << 17,
    CBC_MENUDOWN        = 1 << 18,
    CBC_MENULEFT        = 1 << 19,
    CBC_MENURIGHT       = 1 << 20,
    CBC_MENUSELECT      = 1 << 21,
    CBC_MENUDESELECT    = 1 << 22,
    CBC_MENUBACK        = 1 << 23,
    CBC_MENUCANCEL      = 1 << 24,
    CBC_MENUACTIVATE    = 1 << 25
};

◆ EnumPlayerFlags

enum EnumPlayerFlags

Enumerator
PF_NOCLIP	1 << 0
PF_FLY	1 << 1
PF_DEAD	1 << 2
PF_GOD	1 << 3	Is reset when level beings.
PF_JUMPING	1 << 4	is jumping (moving up). flag is off when reached max jump height or let go of jump button.
PF_HASJUMPED	1 << 5
PF_INWARPAREA	1 << 6	in sector area with AAF_TELEPORT flag.
PF_CLIMBTHRUST	1 << 7
PF_NOAIRFRICTION	1 << 8
PF_CRAWLING	1 << 9
PF_PREVENTDEATHCAM	1 << 10	will stop the death cinematic or the deadAnimView from triggering when the player dies.
PF_FIREDPROJECTILE	1 << 11	set when FireProjectile is called. Cleared OnTick if weapon is not in WS_FIRE state and player is not locked.
PF_FALLINGDEATHPIT	1 << 12	currently falling in a death pit. Cleared after level begins.
PF_WEAPONSTEAL	1 << 13	on when campaigner steals weapon
PF_NOSECTORMUSIC	1 << 14	disables music changes when changing sectors
PF_NOTOUCH	1 << 15	disables invoking onTouch callbacks
PF_NOCEILINGGLIDE	1 << 16	disables the ceiling glide glitch

Definition at line 160 of file t1_scriptAPI.cpp.

{
    PF_NOCLIP           = 1 << 0,
    PF_FLY              = 1 << 1,
    PF_DEAD             = 1 << 2,
    PF_GOD              = 1 << 3,  ///< Is reset when level beings
    PF_JUMPING          = 1 << 4,  ///< is jumping (moving up). flag is off when reached max jump height or let go of jump button.
    PF_HASJUMPED        = 1 << 5,
    PF_INWARPAREA       = 1 << 6,  ///< in sector area with AAF_TELEPORT flag.
    PF_CLIMBTHRUST      = 1 << 7,
    PF_NOAIRFRICTION    = 1 << 8,
    PF_CRAWLING         = 1 << 9,
    PF_PREVENTDEATHCAM  = 1 << 10, ///< will stop the death cinematic or the deadAnimView from triggering when the player dies.
    PF_FIREDPROJECTILE  = 1 << 11, ///< set when FireProjectile is called. Cleared OnTick if weapon is not in WS_FIRE state and player is not locked.
    PF_FALLINGDEATHPIT  = 1 << 12, ///< currently falling in a death pit. Cleared after level begins.
    PF_WEAPONSTEAL      = 1 << 13, ///< on when campaigner steals weapon
    PF_NOSECTORMUSIC    = 1 << 14, ///< disables music changes when changing sectors
    PF_NOTOUCH          = 1 << 15, ///< disables invoking onTouch callbacks
    PF_NOCEILINGGLIDE   = 1 << 16  ///< disables the ceiling glide glitch
};

◆ EnumPlayerStates

enum EnumPlayerStates

Enumerator
PS_WALKING	0
PS_JUMPING	1
PS_CLIMBING	2
PS_SWIMMING	3
PS_UNDERWATER	4
PS_FALLDEATH	5
PS_ANTIGRAVITY	6

Definition at line 181 of file t1_scriptAPI.cpp.

{
    PS_WALKING      = 0,
    PS_JUMPING      = 1,
    PS_CLIMBING     = 2,
    PS_SWIMMING     = 3,
    PS_UNDERWATER   = 4,
    PS_FALLDEATH    = 5,
    PS_ANTIGRAVITY  = 6
};

◆ EnumSectorPlatformFlags

enum EnumSectorPlatformFlags

Enumerator
SPF_FLOORVERTS	1 << 0	Changes sectors verts origin.
SPF_CEILINGVERTS	1 << 1	Changes sectors verts heights.
SPF_SAMEAREA	1 << 2	Effects sectors only with the same area as the starting sector.
SPF_MOVEPLAYERINAIR	1 << 3	Player moves with the sectors even in the air.
SPF_USEMOVETOFORPLAYER	1 << 4	Uses the MoveToPosition function to set the Players origin. else sets origin.
SPF_USEMOVETOFORAI	1 << 5	Uses the MoveToPosition function to set the AI origin. else sets origin.
SPF_USEMOVETOFOROTHER	1 << 6	Uses the MoveToPosition function to set other actors origin. else sets origin.
SPF_MOVEPLAYER	1 << 7	Moves player.
SPF_MOVEAI	1 << 8	Moves AI.
SPF_MOVEOTHERACTORS	1 << 9	Moves other actors on the sectors that are not the player or AI.
SPF_DEFAULT	SPF_FLOORVERTS\|SPF_CEILINGVERTS\|SPF_MOVEPLAYERINAIR\|SPF_USEMOVETOFORPLAYER\|SPF_MOVEPLAYER\|SPF_MOVEAI\|SPF_MOVEOTHERACTORS

Definition at line 484 of file t1_scriptAPI.cpp.

{
    SPF_FLOORVERTS          = 1 << 0,   ///< Changes sectors verts origin
    SPF_CEILINGVERTS        = 1 << 1,   ///< Changes sectors verts heights
    SPF_SAMEAREA            = 1 << 2,   ///< Effects sectors only with the same area as the starting sector
    SPF_MOVEPLAYERINAIR     = 1 << 3,   ///< Player moves with the sectors even in the air
    SPF_USEMOVETOFORPLAYER  = 1 << 4,   ///< Uses the MoveToPosition function to set the Players origin. else sets origin.
    SPF_USEMOVETOFORAI      = 1 << 5,   ///< Uses the MoveToPosition function to set the AI origin. else sets origin.
    SPF_USEMOVETOFOROTHER   = 1 << 6,   ///< Uses the MoveToPosition function to set other actors origin. else sets origin.
    SPF_MOVEPLAYER          = 1 << 7,   ///< Moves player
    SPF_MOVEAI              = 1 << 8,   ///< Moves AI
    SPF_MOVEOTHERACTORS     = 1 << 9,   ///< Moves other actors on the sectors that are not the player or AI.
 
    SPF_DEFAULT = SPF_FLOORVERTS|SPF_CEILINGVERTS|SPF_MOVEPLAYERINAIR|SPF_USEMOVETOFORPLAYER|SPF_MOVEPLAYER|SPF_MOVEAI|SPF_MOVEOTHERACTORS
};

◆ EnumWaterLevel

enum EnumWaterLevel

Enumerator
WLT_INVALID	0	Not in water sectors.
WLT_OVER	1	In water sector but over the water height.
WLT_BETWEEN	2	In water sector and floating above the water.
WLT_UNDER	3	In water sector and under the water height.

Definition at line 402 of file t1_scriptAPI.cpp.

{
    WLT_INVALID = 0, ///< Not in water sectors
    WLT_OVER    = 1, ///< In water sector but over the water height
    WLT_BETWEEN = 2, ///< In water sector and floating above the water
    WLT_UNDER   = 3  ///< In water sector and under the water height
};

◆ EnumWeaponStates

enum EnumWeaponStates

Enumerator
WS_IDLE	0
WS_RAISE	1
WS_LOWER	2
WS_FIRE	3	Is currently firing.
WS_HOLDSTER	4	Set when dead (with no death cinematic) or when climbing. Should set weapon anim to ANIM_WEAPONSWAPOUT if you set this state manually.
WS_WALK	5	NOT USED.
WS_RUN	6	NOT USED.
WS_DISCHARGE	7	set after OnEndFire is called. If was in WS_FIRE state and not pressing the Attack button.
WS_FIREUNDERWATER	8	NOT USED.

Definition at line 270 of file t1_scriptAPI.cpp.

{
    WS_IDLE             = 0,
    WS_RAISE            = 1,
    WS_LOWER            = 2,
    WS_FIRE             = 3, ///< Is currently firing
    WS_HOLDSTER         = 4, ///< Set when dead (with no death cinematic) or when climbing. Should set weapon anim to ANIM_WEAPONSWAPOUT if you set this state manually.
    WS_WALK             = 5, ///< NOT USED
    WS_RUN              = 6, ///< NOT USED
    WS_DISCHARGE        = 7, ///< set after OnEndFire is called. If was in WS_FIRE state and not pressing the Attack button.
    WS_FIREUNDERWATER   = 8  ///< NOT USED
};

◆ kexLocPlatform_e

enum kexLocPlatform_e

< Not used (garbage included automatically from kexengine)

Enumerator
LocPlatform_UserPlatformCount	8
LocPlatform_Windows	1
LocPlatform_Linux	2
LocPlatform_Mac	4
LocPlatform_Switch	8
LocPlatform_XboxOne	16
LocPlatform_PlayStation4	32
LocPlatform_XboxSeries	64
LocPlatform_WindowsStore	128
LocPlatform_PlayStation5	256
LocPlatform_FirstUserPlatform	16777216
LocPlatform_Current	1

Definition at line 8 of file t1_scriptAPI.cpp.

{
    LocPlatform_UserPlatformCount   = 8,
    LocPlatform_Windows             = 1,
    LocPlatform_Linux               = 2,
    LocPlatform_Mac                 = 4,
    LocPlatform_Switch              = 8,
    LocPlatform_XboxOne             = 16,
    LocPlatform_PlayStation4        = 32,
    LocPlatform_XboxSeries          = 64,
    LocPlatform_WindowsStore        = 128,
    LocPlatform_PlayStation5        = 256,
    LocPlatform_FirstUserPlatform   = 16777216,
    LocPlatform_Current             = 1
};

Function Documentation

◆ Abs()

int Abs ( int i )

Returns the absolute value of i.

◆ Accelerate()

float Accelerate	(	const float	val,
		const float	accel,
		const float	max )

return val that increases by accel in a weird way to the max value.

◆ ACos()

float ACos ( float f )

Returns the arc-cosine of f - the angle in radians whose cosine is f.

◆ Add()

bool Sin::Add	(	const kStr &in	key,
		const kStr &in	value )

if the key doesn't exist then adds the key/value and returns false. If the key already exists then sets the value and returns true.

◆ ATan2()

float ATan2	(	float	y,
		float	x )

Returns the angle in radians whose Tan is y/x.

◆ Ceil()

float Ceil ( float f )

Returns the smallest integer greater to or equal to f.

◆ Clamp()

int Clamp	(	const int	i,
		const int	min,
		const int	max )

Returns clamped value between min and max.

◆ Clampf()

float Clampf	(	const float	f,
		const float	min,
		const float	max )

Returns clamped value between min and max.

◆ Clear()

void Sin::Clear ( )

◆ Cos()

float Cos ( float f )

Returns the cosine of angle f in radians.

◆ CosArc()

float CosArc ( const float t )

return (-((Cos(Deg2Rad(360.0f * t)) - 1.0f) * 0.5f));

◆ CosTween()

float CosTween ( const float t )

return (0.5f - (Cos(t * pi) * 0.5f));

◆ Count()

uint Sin::Count ( )

◆ Deg2Rad()

float Deg2Rad ( float degs )

Degrees-to-radians conversion.

◆ delay()

void delay ( const float time )

used in map scripts to delay execution of script

◆ f2i()

const int f2i ( const float f )

IEEE 754 float to int.

◆ Fabs()

float Fabs ( float f )

Returns the absolute value of f.

◆ Find()

bool Sin::Find	(	const kStr &in	key,
		kStr &out	value )

if the key exists then sets value and returns true. If key was not found then returns false.

◆ Floor()

float Floor ( float f )

Returns the largest integer smaller to or equal to f.

◆ GameModFileDataSetAdd()

void GameModFileDataSetAdd	(	const kStr &in	key,
		const kStr &in	value )

Adds the key and value to GameModFileData if it doesn't exist otherwise sets the existing keys value.

◆ GameVarsSetAdd()

void GameVarsSetAdd	(	const kStr &in	key,
		const kStr &in	value )

Adds the key and value to GameVariables if it doesn't exist otherwise sets the existing keys value.

◆ HasKey()

bool Sin::HasKey ( const kStr &in key )

Returns true if the key exists.

◆ HermiteBlend()

float HermiteBlend	(	const float	a,
		const float	b,
		const float	t )

◆ i2f()

const float i2f ( const int i )

int to IEEE 754 float

◆ IncMax()

float IncMax	(	const float	val,
		const float	inc,
		const float	dest )

returns val +(or minus) inc and never goes above or below dest value

◆ InvSqrt()

float InvSqrt ( float f )

Returns inverse square root of f.

◆ IsEmpty()

bool Sin::IsEmpty ( )

◆ ItBegin()

void Sin::ItBegin ( )

Resets the iterator back to the first key/value.

◆ ItNext()

bool Sin::ItNext	(	kStr &out	key,
		kStr &out	value )

key and value is set to the next key/value in the iterator. Returns false if reached the end.