Old Script API

ScriptObject
void OnTick() - Required for all ScriptObject
void OnSpawn() - Required for all ScriptObject
void OnBeginLevel()
void OnPostBeginLevel()
void OnEndLevel()
void OnActivate()
void OnDeactivate()
void OnDamage(kActor @instigator, kDictMem @damageDef, const int damage)
void OnDeath(kActor @killer, kDictMem @damageDef)
void OnSleep()
void OnWake()
void OnTouch(kActor @theActorThatTouchedMe)
void OnRestore()
void OnCollide(kCModel@)

ScriptObjectWeapon
void OnBeginFire()
void OnFire()
void OnEndFire()
void OnLower()
void OnRaise()
void OnHoldster()

ScriptObjectPlayer
void OnPickup(kActor @pickup)
void OnArmorDamage(kActor @instigator, kDictMem @damageDef, const int damage)
void OnEnterWater()

kAnimState
void Blend(const int animID, float speed, float blend, int AnimStateFlags)
void Set(const int animID, float speed, int AnimStateFlags)
const int CurrentFrame(void)
const int NumFrames(void)
const float PlayTime(void)
const float TrackTime(void)
bool IsPlaying(const int animID)
bool CheckAnimID(const int animID) - checks if animID exists
const int PlayingID(void)
void Stop(void)
void Pause(void)
void Resume(void)
const bool Stopped(void)
const bool Blending(void)
const bool Looping(void)
const bool CycleCompleted(void)
void ChangeSpeed(const float speed)
void SetLastFrame(const bool = false)

kRenderModel
void SetModel(const kStr &in modelPath, const kStr &in modelAnimPath)
void SetRotationOffset(const int, const float, const float, const float, const float)
void SetRotationOffset(const int, const kQuat &in)
void SetTexture(const int section, const int textureID)
void SetVisibility(const int node, const bool visible)
void HideSection(const int node, const int section, const bool hide)
void AddTrailEffect(const kStr &in, const int)
void RemoveTrailEffect(void)
const int GetNumAttachedTrails(void)
kVec3 &Offset(void)

kScriptObject
ref &obj;

kActor, kPuppet, kWeapon, kAI
const bool IsStale() - Is the object removed
kAngle &Yaw()
kAngle &Pitch()
kAngle &Roll()
kVec3 &Origin()
kVec3 &Scale()
kVec3 &PrevOrigin()
void SetTarget(kActor@)
kActor @GetTarget(void)
void SetSector(const uint)
void Remove(void)
kVec3 &Velocity(void)
kVec3 &Movement(void)
kQuat &Rotation(void)
int16 &Health(void)
int &Type(void)
int &ImpactType(void)
int &ModelVariation(void)
uint &Flags(void)
const uint SpawnFlags1(void)
const uint SpawnFlags2(void)
const uint SpawnFlags3(void)
const int TID(void) - T stands for Tag ID
float &Radius(void)
float &Height(void)
float &StepHeight(void)
float &WallRadius(void)
float &Gravity(void)
float &Friction(void)
float &AnimSpeed(void)
float &BounceDamp(void)
float &FloorHeight(void)
float &CeilingHeight(void)
const int SectorIndex(void)
const int AreaID(void)
bool InstanceOf(const kStr &in)
void PlaySound(const kStr &in)
void PlaySoundWithLookupID(const int)
void StopSound(void)
void StopLoopingSounds(void)
const int GameTicks(void)
kAnimState &AnimState(void)
kRenderModel @RenderModel(void)
const bool InWater(void)
bool CheckPosition(const kVec3 &in)
bool CheckPosition(const float, const float)
float GetTurnYaw(const kVec3 &in)
float GetAvoidanceAngle(const kVec3 &in, const float)
const float GetWaterHeight(void)
const bool CanSee(kActor@, const uint = 0)
uint &ClipFlags(void)
kDictMem @Definition(void)
bool OnGround(void)
const int GetWaterLevel(void)
kActor @CastToActor(void)
kAI @CastToAI(void)
void SpawnProjectile(const kStr &in, const kVec3 &in, const kVec3 &in, const float)
void MeleeObject(const kStr &in, const kVec3 &in, const float)
void SpawnFx(const kStr &in, const kVec3 &in)
void SpawnFx(const kStr &in, const kVec3 &in, const kQuat &in)
kVec3 GetTransformedVector(const kVec3 &in)
float DistanceToPoint(const kVec3 &in)
float DistanceToPoint(const float, const float, const float)
void InflictGenericDamage(kActor@, const int)
void InteractActorsAtPosition(const kVec3 &in, const kStr &in, const float = 0, const float = 0, const float = 0, const float = 0)
kScriptObject @ScriptObject(void)
void MoveToPosition(const float, const float)
bool RandomDecision(const int)
void SetPosition(const kVec3 &in)
const int16 SpawnParams(const int)
const float GetCeilingHeight(void)
const float GetFloorHeight(void)
void RunFxEvent(const kStr &in)
const int GetSectorIndexAtLocation(const kVec3 &in, uint = 0)
void MarkPersistentBit(const bool)
const bool IsPersistentMarked(void)
void SetHeadTrackTarget(kActor@)
kVec3 TransformToOwnerPosition(void)
kVec3 TransformToOwnerPosition(const kVec3 &in)
void FireProjectile(const kStr &in, const float x, const float y, const float z, const bool = false)
const bool CanSee(kPuppet@, const uint = 0)
float &ViewHeight(void)
float &RecoilPitch(void)
const float LandingViewOffset(void)
uint &PlayerFlags(void)
void QuietNoiseAlert(void)
void LoudNoiseAlert(void)

kAI
uint &AIFlags(void)

EnumAnimStateFlags
ANF_BLEND
ANF_LOOP
ANF_STOPPED
ANF_NOINTERRUPT
ANF_ROOTMOTION
ANF_PAUSED
ANF_CYCLECOMPLETED

EnumActorFlags
AF_SOLID
AF_DORMANT
AF_SNAPTOFLOOR
AF_WOUNDEDMORTALLY
AF_CASTSHADOW
AF_TRIGGERSTUFF
AF_HIDDEN
AF_ACTIVATED
AF_DISABLED
AF_ENTEREDAREAEVENT
AF_REMOVEONCOMPLETION
AF_NOBLOOD
AF_AVOIDWATER
AF_FLOATINWATERONDEATH
AF_DEAD
AF_STATIONARY
AF_ALIGNTOFLOOR
AF_NODRAW
AF_NONSHOOTABLE
AF_FULLVOLUME
AF_CANBETOUCHED
AF_IGNORESOUNDEVENTS
AF_TRIGGERANIMATION
AF_HOLDTRIGGERANIM
AF_TRIGGERNAIMDELAY
AF_STAYINWATER
AF_ALWAYSACTIVE
AF_COLLIDEDWITHWALL
AF_INVINCIBLE
AF_ALLOWTINYENEMYCHEAT
AF_NOMOVEMENT

EnumPlayerFlags
PF_NOCLIP
PF_FLY
PF_DEAD
PF_GOD
PF_JUMPING
PF_HASJUMPED
PF_INWARPAREA
PF_CLIMBTHRUST
PF_NOAIRFRICTION
PF_CRAWLING
PF_PREVENTDEATHCAM
PF_FIREDPROJECTILE

EnumAIFlags
AIF_ATTACKING
AIF_WASSOLID
AIF_BLOWNAWAY
AIF_NOCHASE
AIF_NOTHINK
AIF_RUNNING
AIF_TELEPORTING

EnumImpactType
IT_DEFAULT
IT_WATER
IT_METAL
IT_STONE
IT_FLESH_HUMAN
IT_FLESH_CREATURE
IT_FLESH_UNDEAD
IT_LAVA
IT_SLIME
IT_FORCEFIELD

kDict
void Add(const kStr &in, const kStr &in)
void Empty(void)
void SetValue(const kStr &in, const kStr &in)
const bool HasKey(const kStr &in)
bool GetFloat(const kStr &in, float &out, const float defaultValue = 0)
bool GetInt(const kStr &in, int &out, const int defaultValue = 0)
bool GetBool(const kStr &in, bool &out, const bool defaultValue = false)
bool GetString(const kStr &in, kStr &out)
bool GetVector(const kStr &in, kVec3 &out)

kDictMem
bool GetFloat(const kStr &in, float &out, const float defaultValue = 0)
bool GetInt(const kStr &in, int &out, const int defaultValue = 0)
bool GetBool(const kStr &in, bool &out, const bool defaultValue = false)
bool GetString(const kStr &in, kStr &out)
bool GetVector(const kStr &in, kVec3 &out)

kSelectionListInt
void AddItem(int, const int)
int Select(void)
void Reset(void)
const uint GetNumEntries(void)
&opAssign(const kSelectionListInt &in)

kSelectionListFloat
&opAssign(const kSelectionListFloat &in)

GameVariables
void GetInt(const kStr &in, int &out, int defaultValue = 0);
void GetFloat(const kStr &in, float &out, float defaultValue = 0.0f);
void GetBool(const kStr &in, bool &out, bool defaultValue = false);
void GetVector(const kStr &in, kVec3 &out);
void SetValue(const kStr &in, const kStr &in);

Game
void CallDelayedMapScript(const kStr &in, kActor @instigator, const float delay)
void CallDelayedMapScript(const int scriptID, kActor @instigator, const float delay)
void HaltMapScript(const int scriptID)
void PlayMusic(const kStr &in path, const bool loop)
void StopMusic(void)
void Restart(void)
void PrintLine(const kStr &in text, const int lineNumber, const int visibleFrameTime = 120)
void PrintHelp(const kStr &in localizedKey, const bool endGame = false)
void ChangeMap(const kStr &in path)
void ShowMainMenu(void)
const int GetMapNumberFromName(const kStr &in)
const int GetCurrentMapID(void)
const int GetDifficulty(void)
bool GetHubKeyInfo(const uint, int &out, int &out, int &out)
void SpawnFx(const kStr &in, kActor@, const kVec3 &in, const kVec3 &in, const kQuat &in)
void SpawnFx(const kStr &in, kPuppet@, const kVec3 &in, const kVec3 &in, const kQuat &in)
void SpawnFx(const kStr &in, kActor@, const kVec3 &in, const kQuat &in)
void SpawnFx(const kStr &in, kPuppet@, const kVec3 &in, const kQuat &in)
void SpawnFx(const kStr &in, kActor@, const kVec3 &in, const float, const float)
void SpawnFx(const kStr &in, kPuppet@, const kVec3 &in, const float, const float)
void SpawnFx(const kStr &in, const kVec3 &in, const int)
kStr GetLocalizedText(const kStr &in)

ActorFactory
kActor@ Spawn(const int actorID, const float x, const float y, const float z, const float yaw, const int sector = -1)
kActor@ Spawn(const kStr &in actorName, const float x, const float y, const float z, const float yaw, const int sector = -1)

PlayLoop
const int Ticks(void)
const void TagActorForBossBar(kActor@)
void RemoveBossActor(void)
void CheckKeys(void)
void StartWarp(kActor@, const int tagID, const int mapID)
void StartFreeWarp(kActor@, const kVec3 &in origin, const float yaw, const int sectorID, const int mapID)
void HandlePlayerDeath(const bool = true)

Player
const uint16 Buttons(void)
const kPuppet @Actor(void)
void ConsumeAmmo(const int ammo)
const int GetAmmo(const int weaponID)
const int GetAltAmmo(const int weaponID)
const bool HasAmmo(const int weaponID)
const bool HasAltAmmo(const int weaponID)
const bool HasAltAmmo(void)
const bool HasWeapon(const int weaponID)
const int CurrentWeapon(void)
const bool GiveWeapon(const int weaponID, const int ammo)
void Lock(void)
void Unlock(void)
int16 &Armor(void)
void Victory(const int = -1, const int = -1)
const bool Locked(void)
const kPlayer &Owner(void)

Global Constants
const float GAME_DELTA_TIME
const float GAME_SCALE
const float GAME_FRAME_TIME
const float GAME_FRAME_UNIT
const float GAME_SECONDS

Camera
void StartCinematic(const uint EnumCameraFlag = 12)
void StopCinematic(void)
const int CinematicState(void)
const void SetLookAtActor(kActor@)
void ClearLookAtActor(void)
void SetRotateEyeVector(const kVec3 &in)
void SetFinalView(const int)
void SetRotationTrack(const int trackID, const float startAngle, const float destAngle, const float startDistance, const float destDistance,
						const float startHeight = 0, const float destHeight = 0, const float startLookHeight = 0, const float destLookHeight = 0)
void SetPositionTrack(const int trackID, const kVec3 &in, const kVec3 &in, const kVec3 &in, const kVec3 &in)
void TweenPositionTrack(const int trackID, const float time)
void TweenRotationTrack(const int trackID, const kVec3 &in, const float time)
void AutoPlayPositionTrack(const int trackID, const float time, const int EnumCameraLerpType)
void AutoPlayRotationTrack(const int trackID, const float time, const int EnumCameraLerpType)
void AutoPlayBlendTrack(const int trackID, const int blendTrack1ID, const int blendTrack2ID, const float time, const int EnumCameraLerpType)
void SetEyeView(const kVec3 &in)
void SetFocusView(const kVec3 &in)
void ZoomEyeViewToPosition(const kVec3 &in, const float)
void ZoomFocusViewToPosition(const kVec3 &in, const float)
kVec3 GetEyeView(void)
kVec3 GetFocusView(void)
void ClearFinalView(void)
void ClearViewTracks(void)
const bool UserInterrupted(void)
const bool Active(void)
const bool ViewingFromCamera(void)
const kVec3 &Tremor(void)
kVec3 origin
kAngle yaw
kAngle pitch
kAngle roll
float fov
float lookZOffset

World
kActor @GetActorByTID(const int tagID, const int = -1)
const bool TriggerActorsByTID(kActor@, const int tagID)
void ChangeAreaFlag(const int areaID, const uint EnumAreaFlag, const bool active)
void FloodFillAreaFlags(const int, const uint, const bool)
void FloodFillAreaFlags(const kVec3 &in, const uint, const bool)
void FloodMatchingAreaFlags(const int areaID, const uint, const bool)
const uint GetAreaFlags(const int areaID)
const void ChangeAreaWaterHeight(const int areaID, const float height)
const int16 GetAreaArg(const int areaID, const int arg)
const void ChangeAreaArg(const int areaID, const int arg, const int16 value)
            // though args can be used for anything, they are typically used in this fashion:
            //
            // 0: warp ID
            // 1: warp level ID or trigger sound ID
            // 2: checkpoint ID
            // 3: tag ID
            // 4: floor damage hit points
            // 5: floor damage rate
void ChangeSectorHeight(const int sector, const float height)

CModel
kVec3 &InterceptVector(void)
kVec3 &ContactNormal(void)
const float &Fraction(void)
const uint ClipResult(void)
kActor @ContactActor(void)

EnumPlayerButtons
BC_ATTACK
BC_JUMP
BC_FORWARD
BC_BACKWARD
BC_STRAFELEFT
BC_STRAFERIGHT
BC_WEAPONRIGHT
BC_WEAPONLEFT
BC_MAPZOOMIN
BC_MAPZOOMOUT

EnumDifficulty
DIFFICULTY_EASY
DIFFICULTY_NORMAL
DIFFICULTY_HARD
DIFFICULTY_HARDCORE

EnumClipFlags
CF_CLIPEDGES
CF_IGNOREBLOCKERS
CF_DROPOFF
CF_NOENTERWATER
CF_NOEXITWATER
CF_NOCLIPSTATICS
CF_NOCLIPACTORS
CF_WALKWALLS
CF_COLLIDEFLOORS
CF_HITSCAN
CF_ALLOWCLIMB
CF_ALLOWCRAWL
CF_NOSTEPDOWN
CF_NOSLOPESTEP
CF_COLLIDEHEIGHT
CF_COLLIDECORPSES
CF_NOEXITWALLS
CF_NOCOLLIDEFUNC
CF_NOFLOORADJUST
CF_NOCEILINGADJUST
CF_COLLIDEWATER

EnumWaterLevel
WLT_INVALID - Not in water area
WLT_OVER - in water area and over the water height
WLT_BETWEEN - in water area and floating above the water
WLT_UNDER - in water area and under the water height

EnumCameraLerpType
CMLT_NONE
CMLT_LINEAR
CMLT_LINEARLOOP
CMLT_COSINE
CMLT_COSINE_POW

EnumCameraFlags
CMF_NO_INITIAL_FADEOUT
CMF_NO_LETTERBOX
CMF_LOCK_PLAYER
CMF_UNLOCK_PLAYER_ON_FINISH
CMF_INITIAL_FADEIN
CMF_SHOW_CREDITS
CMF_CHANGE_MAP_AFTER_FADE
CMF_SHOW_HIDDEN_OBJECTS

EnumAreaFlags
AAF_WATER
AAF_BLOCK
AAF_TOGGLE
AAF_CLIFF
AAF_CLIMB
AAF_ONESIDED
AAF_CEILING
AAF_CRAWL
AAF_ENTERCRAWL
AAF_HIDDEN
AAF_ENTERED
AAF_RESTRICTED
AAF_SLOPETEST
AAF_DEATHPIT
AAF_MAPPED
AAF_EVENT
AAF_REPEATABLE
AAF_TELEPORT
AAF_DAMAGE
AAF_DRAWSKY
AAF_TELEPORTAIR
AAF_LAVA
AAF_EVENTSOUND
AAF_ANTIGRAVITY
AAF_LADDER
AAF_CHECKPOINT
AAF_SAVEGAME
AAF_WARPRETURN
AAF_SHALLOWWATER
AAF_DRAWSUN

Math
float Sin(float)
float Cos(float)
float Tan(float)
float ATan2(float, float)
float Fabs(float)
float ACos(float)
float Sqrt(float)
int Abs(int)
float Ceil(float)
float Floor(float)
float Log(float)
float Pow(float, float)
float Deg2Rad(float)
float Rad2Deg(float)
float InvSqrt(float)
float IncMax(const float, const float, const float)
int SysRand(void)
int Rand(void)
uint8 RandByte(void)
int RandMax(const int)
float NLerp(const float, const float, const float)
float RandFloat(void)
float RandCFloat(void)
float RandRange(const float, const float)
void Clamp(float &out, const float, const float)
float Lerp(float, const float, const float)
float CosTween(const float)
float CosArc(const float)
float pi
kVec3 vecZero

kVec3
void Contructor(float x, float y, float z)
void Contructor(const kVec3 &in)
kVec3 &Normalize(void)
kVec3 Cross(const kVec3 &in)
const float Dot(const kVec3 &in)
const float Unit(void)
const float UnitSq(void)
const float Distance(const kVec3 &in)
const float DistanceSq(const kVec3 &in)
const kStr ToString(void)
float ToYaw(void)
float ToPitch(void)
void Clear(void)
void Set(const float, const float, const float)
kVec3 Lerp(const kVec3 &in, const float)
const kVec3 &Lerp(const kVec3 &in, const float)
kVec3 &Randomize(const float)
kVec3 &CubicCurve(const kVec3 &in, const float, const kVec3 &in)
kVec3 &QuadraticCurve(const kVec3 &in, const float, const kVec3 &in, const kVec3 &in)
kVec3 opAdd(const kVec3 &in)
kVec3 &opAddAssign(const kVec3 &in)
kVec3 opNeg(void)
kVec3 opSub(const kVec3 &in)
kVec3 &opSubAssign(const kVec3 &in)
kVec3 opMul(const kVec3 &in)
kVec3 opMul(const float val)
kVec3 &opMulAssign(const kVec3 &in)
kVec3 &opMulAssign(const float)
kVec3 opDiv(const kVec3 &in)
kVec3 opDiv(const float val)
kVec3 &opDivAssign(const kVec3 &in)
kVec3 &opAssign(const kVec3 &in)
float opIndex(uint)
const float opIndex(uint)
float x
float y
float z

kQuat
void Contructor(float x, float y, float z, float w)
void Contructor(float w, kVec3 &in)
void Contructor(const kQuat &in)
kQuat &Normalize(void)
kQuat opAdd(const kQuat &in)
kQuat opSub(const kQuat &in)
kQuat opMul(const kQuat &in)
kQuat &opAssign(const kQuat &in)
kVec3 opMul(const kQuat &in)
kVec3 &opMulAssign(const kQuat &in)
kQuat ToQuaternion(void)
float w
kQuat ToQuat(void)

kAngle
void Contructor(float)
void Contructor(const kAngle &in)
float Diff(const float)
float Diff(const kAngle &in)
float Interpolate(const float, const float)
kAngle opAdd(const float)
const kAngle &opAddAssign(const float)
kAngle opSub(const float)
const kAngle &opSubAssign(const float)
kAngle opAdd(const kAngle &in)
const kAngle &opAddAssign(const kAngle &in)
kAngle opSub(const kAngle &in)
const kAngle &opSubAssign(kAngle &in)
kAngle &opAssign(const float)
kAngle &opAssign(const kAngle &in)
kAngle opNeg(void)
const float opImplConv(void)

kStr
void Contructor(const kStr &in)
int IndexOf(const kStr &in) - only way to compare strings?
const uint Hash(void)
int Atoi(void)
float Atof(void)
kStr &ToUpper(void)
kStr &ToLower(void)
kStr &opAssign(const kStr &in)
kStr opAdd(const kStr &in)
int8 opIndex(const int)
kStr opAdd(bool)
kStr opAdd(int)
kStr opAdd(float)
kStr &opAddAssign(const kStr &in)
kStr &opAddAssign(bool)

Sys
void Print(const kStr &in)
void Warning(const kStr &in)
int VideoWidth(void)
int VideoHeight(void)
int Mouse_X(void)
int Mouse_Y(void)
const bool GetCvarValue(const kStr &in, kStr &out)