607 int find(
const T&in value)
const;
614 int find(uint startAt,
const T&in value)
const;
632 funcdef
bool less(
const ?&in a,
const ?&in b);
633 void sort(
less&in, uint startAt = 0, uint count = uint ( - 1 ));
686 float Diff(
const float rads)
const;
722 void Set(
const float x,
const float y,
const float z);
773 kQuat(
float rotX,
float rotY,
float rotZ);
779 void GetAngles(
float&out yaw,
float&out pitch,
float&out roll);
781 void Set(
const float x,
const float y,
const float z,
const float w);
803 kPlane(
const float a,
const float b,
const float c,
const float d);
851 void RGBToHSV(
float&out hue,
float&out sat,
float&out result)
const;
853 void RGBToHSL(
float&out hue,
float&out sat,
float&out lit)
const;
1059 bool GetFloat(
const kStr&in key,
float&out floatResult,
const float defaultValue = 0);
1060 bool GetInt(
const kStr&in key,
int&out intResult,
const int defaultValue = 0);
1061 bool GetBool(
const kStr&in key,
bool&out boolResult,
const bool defaultValue =
false);
1073 bool GetFloat(
const kStr&in key,
float&out floatResult,
const float defaultValue = 0);
1074 bool GetInt(
const kStr&in key,
int&out intResult,
const int defaultValue = 0);
1075 bool GetBool(
const kStr&in key,
bool&out boolResult,
const bool defaultValue =
false);
1114 void SetRotationOffset(
const int nodeIndex,
const float rads,
const float x,
const float y,
const float z,
const bool clearInterpolation =
false);
1118 void HideSection(
const int nodeIndex,
const int section,
const bool hide);
1162 void GetMorphFrame(
int&out frame,
int&out nextFrame,
int&out maxFrames,
float&out time)
const;
1164 void ColorOverride(
const int node,
const float r = 1.0f,
const float g = 1.0f,
const float b = 1.0f,
const float a = 1.0f);
1172 void Blend(
const int animID,
float speed,
float blend,
int flags);
1173 void Blend(
const int animID,
float speed,
float blend,
int flags,
const int frame,
const bool runActions =
true,
const bool noSoundActions =
false);
1175 void Set(
const int animID,
float speed,
int flags,
const int frame,
const bool runActions =
true,
const bool noSoundActions =
false);
1367 void RunAction(
const int funcID,
const float w = 0.0f,
const float x = 0.0f,
const float y = 0.0f,
const float z = 0.0f);
1441 kFx @
FireProjectile(
const kStr&in fxPath,
const float x,
const float y,
const float z,
const bool adjustToPerspective =
false);
1565 kActor@
Spawn(
const int actorID,
const float x,
const float y,
const float z,
const float yaw,
const int sector = - 1);
1566 kActor@
Spawn(
const kStr&in actorName,
const float x,
const float y,
const float z,
const float yaw,
const int sector = - 1);
1663 void GetColor1(
float &out r,
float &out g,
float &out b,
float &out a);
1664 void GetColor2(
float &out r,
float &out g,
float &out b,
float &out a);
1685 void SpawnImpactFx(
const int impactType,
const kVec3 &in normal,
const bool bUseEvent =
true,
const bool bBlood =
true);
1788 void SetRotationTrack(
const int view,
const float startAngle,
const float destAngle,
const float startDist,
const float destDist,
const float startEyeZOffset = 0,
const float destEyeZOffset = 0,
const float startFocusZOffset = 0,
const float destFocusZOffset = 0);
1794 void AutoPlayBlendTrack(
const int viewA,
const int viewB,
const int viewC,
const float speed,
const int lerpType);
2001 void GetSectorLinks(
const int sectorIndex,
int&out sectorIndex1,
int&out sectorIndex2,
int&out sectorIndex3)
const;
2084 void PrintLine(
const kStr&in text,
const int lineNumber,
const int ticks = 120);
2110 bool GetHubKeyInfo(
const uint hubID,
int&out nKeys,
int&out remainingKeys,
int&out keyBits);
2112 bool SetHubKey(
const uint hubID,
int keyBits,
int remainingKeys);
2173 const int64 GetTimestamp();
2174 void GetDateAndTime(
int&out seconds,
int&out minutes,
int&out hours,
int&out day,
int&out month,
int&out year,
kStr&out text);
2184 void AddText(
const int id,
const int font,
const kStr &in text,
const float x,
const float y,
2185 const int edge = 0,
const float scale = 1.0f,
const bool center =
false,
const bool shadow =
false,
2186 const int r = 255,
const int g = 255,
const int b = 255,
const int a = 255,
2187 const int r2 = 255,
const int g2 = 255,
const int b2 = 255,
const int a2 = 255);
2190 bool SetTextColor(
const int id,
const int r = 255,
const int g = 255,
const int b = 255,
const int a = 255);
2191 bool SetTextColors(
const int id,
const int r = 255,
const int g = 255,
const int b = 255,
const int a = 255,
const int r2 = 255,
const int g2 = 255,
const int b2 = 255,
const int a2 = 255);
2198 bool SetTextProps(
const int id,
const float scale,
const int font = 0,
const int edge = 0,
const bool center =
false,
const bool shadow =
false);
2204 void GetTextSize(
const kStr &in text,
const int font,
const float scale,
float &out width,
float &out height);
2213 bool AddPic(
const int id,
const kStr &in path,
const float x,
const float y,
const float w,
const float h,
const int edge = 0,
2214 const float s1 = 0.0f,
const float t1 = 0.0f,
const float s2 = 1.0f,
const float t2 = 1.0f,
2215 const int r = 255,
const int g = 255,
const int b = 255,
const int a = 255);
2221 bool SetPicWH(
const int id,
const float w,
const float h);
2222 bool SetPicUV(
const int id,
const float s1 = 0.0f,
const float t1 = 0.0f,
const float s2 = 1.0f,
const float t2 = 1.0f);
2223 bool SetPicColor(
const int id,
const int r = 255,
const int g = 255,
const int b = 255,
const int a = 255);
2329 void PlayMusicID(
const int musicID,
const int fadeTimeMS = 500,
const bool loop =
true);
2402 const bool HasAmmo(
const int weaponID,
const bool checkAlt =
true)
const;
2408 bool GiveWeapon(
const int weaponID,
const int ammo,
const bool switchNewWeapon =
true);
2413 void Victory(
const int warpActorID = - 1,
const int mapID = - 1);
2423 bool GiveAmmo(
const int weapon,
const int amount,
const bool altAmmo);
2500 float IncMax(
const float val,
const float inc,
const float dest);
2505 float NLerp(
const float a,
const float b,
const float t);
2506 float Accelerate(
const float val,
const float accel,
const float max);
2510 int Clamp(
const int i,
const int min,
const int max);
2511 float Clampf(
const float f,
const float min,
const float max);
2512 float Lerp(
float start,
const float end,
const float time);
2515 float SmoothStep(
const float from,
const float to,
const float t);
2517 float Min(
const float a,
const float b);
2518 float Max(
const float a,
const float b);
2521 const float pi = 3.1415927f;
void kStrSplit(const kStr &in s, const kStr &in sep)
float RandRange(const float min, const float max)
Returns a random float number between and min [inclusive] and max [inclusive].
float Sqrt(float f)
Returns square root of f.
float Ceil(float f)
Returns the smallest integer greater to or equal to f.
float SmoothStep(const float from, const float to, const float t)
Interpolates between min and max with smoothing at the limits.
float Min(const float a, const float b)
Returns the smallest of the two values.
float RandCFloat()
Range -1..1.
kColor kexColor_ViridisScale(float v)
Not used. (garbage from kexengine)
uint kexRandUInt()
Range 0..4294967295.
int RandMax(const int max)
Range 0..max-1.
EnumCameraLerpType
Lerp type when doing AutoPlayPositionTrack, AutoPlayRotationTrack, or AutoPlayBlendTrack....
@ CMLT_COSINE
time will never be higher than speed. time = CosTween(time * (1.0f / speed));
@ CMLT_LINEARLOOP
time is set to time / speed. If time is > 1.0 then time -= 1.0
@ CMLT_COSINE_POW
time will never be higher than speed. time = CosTween(Pow(time * (1.0f / speed), 3));
@ CMLT_LINEAR
time is set to time / speed.
@ CMLT_NONE
time is set to time / speed.
float Rad2Deg(float rads)
Radians-to-Degrees conversion.
const float GAME_DELTA_TIME
kColor kexColor_Tab20(uint i)
Not used. (garbage from kexengine)
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.
float ACos(float f)
Returns the arc-cosine of f - the angle in radians whose cosine is f.
float CosTween(const float t)
return (0.5f - (Cos(t * pi) * 0.5f));
@ ASF3_MAKESPAWNANIMVISIBLE
clears actor flags: ~(AF_HIDDEN|AF_DISABLED)
@ ASF3_PROJECTILEATTACK9
Demon chest Hadoken (anim_aiRangeAttack9)
@ ASF3_NOTHINKER
AI will not function. Actors will not update movement. Actors OnBeginLevel will set their animation t...
@ ASF3_PLAYTRIGGERANIMONCE
MarkPersistentBit(false) when activated.
@ ASF3_KILLOUTSIDEOFVIEW
NOT USED.
@ ASF3_PROJECTILEATTACK10
High Priest Lightning Red Flames (anim_aiRangeAttack10)
@ ASF3_RETURNWARP
Used in portal scripts.
@ ASF3_WALKINSTRAIGHTLINE
Set animation to Blend(ANIM_WALKING, (m_animSpeed * m_animScalar), 10, ANF_LOOP|ANF_ROOTMOTION); and ...
@ ASF3_AVOIDPLAYERS2
NOT USED.
@ ASF3_REGENERATEFROMSTART
Regen from starting position.
@ ASF3_NOVIOLENTDEATH
ANIM_AIDEATHSTAND and ANIM_DEATHSTANDALT will not play when kAI is killed.
@ ASF3_NODRAWONCAMERA
Will not draw this actor when viewing from camera unless camera flags has CMF_SHOW_HIDDEN_OBJECTS.
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.
kColor kexColor_Tab20Light(uint i)
Not used. (garbage from kexengine)
float Floor(float f)
Returns the largest integer smaller to or equal to f.
@ CRF_MESH
made contact with a static object
@ CRF_ADJUST
z-axis was adjusted (ceiling or floor)
@ CRF_FLOOR
made contact with a floor
@ CRF_WALL
made contact with an edge (sector edge that isn't linked to another sector)
@ CRF_CEILING
made contact with a ceiling
@ CRF_WALLRADIUS
made contact with an edge during the wall radius collision test
@ CRF_OBJECT
made contact with an actor
kDict GameModFileData
Use with Game.SaveModFile, Game.LoadModFile, and Game.LoadModDataFile.
float Lerp(float start, const float end, const float time)
Linearly interpolates between start and end by time.
@ CF_HITSCAN
performs a single-pass trace. useful for hitscans
@ CF_COLLIDEPLAYERBLOCKER
collide with edges linked to player blocking regions (AAF_WARPRETURN)
@ CF_CHECKLINKEDBRIDGES
do extensive checks against overlapping bridge sectors
@ CF_NOCLIPTARGETACTORS
don't clip actors that are targeted by moving object
@ CF_ALLOWCRAWL
collide with sectors flagged as crawlable
@ CF_STANDONOBJECTS
allow vertical clipping of objects
@ CF_ALLOWRESTRICTEDAREAS
don't collide with edges belonging to a restricted sector
@ CF_COLLIDEFLOORS
project and clip movement against non-flat floors
@ CF_USEWALLRADIUS
clip and project movement away from walls based on wall radius
@ CF_DROPOFF
allows passing through platforms or ledges
@ CF_NOCLIPSTATICS
don't collide with static models
@ CF_ALLOWCLIMB
collide with sectors flagged as climbable
@ CF_NOEXITWATER
block all edges that links to a non-water sector
@ CF_WALKWALLS
don't restrict movement to steep slopes
@ CF_NOCOLLIDEFUNC
don't invoke the OnCollide callback on the moving object
@ CF_COLLIDETRIGGERS
block edges belonging to a trigger. Can't cross into sectors if sector has AAF_EVENT.
@ CF_NOEXITWALLS
clip all edges, regardless if they link to another sector or not
@ CF_COLLIDECORPSES
clip against actors flagged as dead
@ CF_POLYCOLLISION
clip movement against all model polygons of an object
@ CF_NOSTEPDOWN
don't clamp z-axis when walking down slopes
@ CF_NOENTERWATER
block all edges that links to a water sector
@ CF_NOCLIPACTORS
don't collide with dynamic objects/actors
@ CF_COLLIDEHEIGHT
clip against ceilings
@ CF_COLLIDECLIFFS
collide with non-walkable floors
@ CF_NOFLOORADJUST
don't keep z-axis above floor plane
@ CF_NOCEILINGADJUST
don't keep z-axis below ceiling plane
@ CF_NOSLOPESTEP
don't project z-axis movement along slopes
@ CF_IGNOREBLOCKERS
don't clip edges belonging to blocking sectors
@ CF_CLIPEDGES
clip movement against edges that don't link to sectors
@ CF_COLLIDEWATER
clip movement against the water surface
@ CF_GREASESLIDEOBJECTS
always keep movement projected away from collided objects
const float GAME_FRAME_UNIT
@ CHF_ALPHASCALE
Scales color alpha values by the HUD opacity menu option.
@ CHF_HIDEMENU
Hide when menu is active.
@ CHF_HIDENOHUD
Hide when Show HUD menu option is off.
@ CHF_HIDECINEMA
Hide when cinema is active.
@ CHF_HIDEDUMMYMENU
Hide when dummy menu is active.
float IncMax(const float val, const float inc, const float dest)
returns val +(or minus) inc and never goes above or below dest value
@ SPF_FLOORVERTS
Changes sectors verts origin.
@ SPF_MOVEPLAYER
Moves player.
@ SPF_USEMOVETOFORPLAYER
Uses the MoveToPosition function to set the Players origin. else sets origin.
@ SPF_MOVEOTHERACTORS
Moves other actors on the sectors that are not the player or AI.
@ SPF_SAMEAREA
Effects sectors only with the same area as the starting sector.
@ SPF_USEMOVETOFORAI
Uses the MoveToPosition function to set the AI origin. else sets origin.
@ SPF_MOVEPLAYERINAIR
Player moves with the sectors even in the air.
@ SPF_USEMOVETOFOROTHER
Uses the MoveToPosition function to set other actors origin. else sets origin.
@ SPF_CEILINGVERTS
Changes sectors verts heights.
kexLocPlatform_e
< Not used (garbage included automatically from kexengine)
@ LocPlatform_PlayStation5
@ LocPlatform_WindowsStore
@ LocPlatform_PlayStation4
@ LocPlatform_UserPlatformCount
@ LocPlatform_FirstUserPlatform
@ WLT_BETWEEN
In water sector and floating above the water.
@ WLT_INVALID
Not in water sectors.
@ WLT_OVER
In water sector but over the water height.
@ WLT_UNDER
In water sector and under the water height.
kColor kexColor_Random()
Not used. (garbage from kexengine)
uint kStrSplitLength()
returns the amount of strings that were split
@ IT_FLESH_UNDEAD
AKA IT_FLESH_WATER. Not used in the remaster for anything by default. In the original game if an Fx w...
const int f2i(const float f)
IEEE 754 float to int.
int Abs(int i)
Returns the absolute value of i.
float Log(float f)
Returns the natural (base e) logarithm of a specified number.
float InvSqrt(float f)
Returns inverse square root of f.
kColor kexColor_LerpRGB(const kColor &in from, const kColor &in to, float time)
Not used. (garbage from kexengine)
@ WS_FIRE
Is currently firing.
@ WS_FIREUNDERWATER
NOT USED.
@ WS_HOLDSTER
Set when dead (with no death cinematic) or when climbing. Should set weapon anim to ANIM_WEAPONSWAPOU...
@ WS_DISCHARGE
set after OnEndFire is called. If was in WS_FIRE state and not pressing the Attack button.
kColor kexColor_FromHSL(float hue, float sat, float lit)
Not used. (garbage from kexengine)
@ PF_NOTOUCH
disables invoking onTouch callbacks
@ PF_GOD
Is reset when level beings.
@ PF_FALLINGDEATHPIT
currently falling in a death pit. Cleared after level begins.
@ PF_WEAPONSTEAL
on when campaigner steals weapon
@ PF_JUMPING
is jumping (moving up). flag is off when reached max jump height or let go of jump button.
@ PF_FIREDPROJECTILE
set when FireProjectile is called. Cleared OnTick if weapon is not in WS_FIRE state and player is not...
@ PF_NOSECTORMUSIC
disables music changes when changing sectors
@ PF_NOCEILINGGLIDE
disables the ceiling glide glitch
@ PF_INWARPAREA
in sector area with AAF_TELEPORT flag.
@ PF_PREVENTDEATHCAM
will stop the death cinematic or the deadAnimView from triggering when the player dies.
float Tan(float f)
Returns the tangent of angle f in radians.
const float GAME_FRAME_TIME
@ AF_NOMOVEMENT
will not do collision movement
@ AF_CLIMBWALLS
allows entering of wall sectors
@ AF_REMOVEONCOMPLETION
remove after finishing a special animation
@ AF_SNAPTOFLOOR
adjust z-axis to floor on spawn
@ AF_ALWAYSACTIVE
never sleep or go dormant
@ AF_HIDDEN
don't draw but continue updating. can't be collided
@ AF_TRIGGERSTUFF
NOT USED.
@ AF_COLLIDEDWITHWALL
collided with an edge. cleared at every OnTick call
@ AF_WOUNDEDMORTALLY
if on this actor will drop a mortal wound because it was hit by a super arrow shot
@ AF_CANBETOUCHED
allow invoking the OnTouch callback
@ AF_IGNORESOUNDEVENTS
don't call kexAnimState::Action_PlaySound
@ AF_DISABLED
don't update animations
@ AF_DEAD
actor is dead. handle special cases for collision
@ AF_CASTSHADOW
can cast a simple shadow
@ AF_ALLOWTINYENEMYCHEAT
affected by tiny enemy game cheat
@ AF_SOLID
Can be collided.
@ AF_STAYINWATER
can't exit water sectors
@ AF_ALIGNTOFLOOR
rotate along slopes
@ AF_INVINCIBLE
will not receive damage. OnDamage and OnDeath are never called
@ AF_AVOIDWATER
clip against edges linking to water sectors
@ AF_NONSHOOTABLE
Fx won't hit actors if this flag is set.
@ AF_FLOATINWATERONDEATH
rise to the surface while dead
@ AF_ACTIVATED
was triggered
@ AF_NOBLOOD
don't spawn particles flagged as blood
@ AF_ENTEREDAREAEVENT
just entered a trigger sector
@ AF_DORMANT
if on then is asleep (won't be updated onTick) else is awake
@ AF_TRIGGERANIMATION
play special animation on trigger/spawn
@ AF_TRIGGERNAIMDELAY
delay a bit before starting special animation
@ AF_HOLDTRIGGERANIM
pause special animation until triggered (is also invincible)
@ AF_STATIONARY
Sniper. don't update the animation's root motion.
@ AF_FULLVOLUME
all sounds coming from this actor will be heard at full volume
@ ASF1_CASTSHADOW
sets AF_CASTSHADOW on SetSpawnParams
@ ASF1_FLOATINWATERONDEATH
kAI will float up to the top of the water when they are dead
@ ASF1_RANDOMFEIGNDEATH
NOT USED.
@ ASF1_SCREENSHAKE
Used in floor mover scripts to shake screen.
@ ASF1_PROJECTILEATTACK2
Pistol Fire (anim_aiRangeAttack2)
@ ASF1_KAMIKAZE
if has no target then targets player and sets agitation to 300
@ ASF1_AVOIDPLAYERS
NOT USED.
@ ASF1_TELEPORTAVOIDCLIFFS
@ ASF1_NOWALLCOLLISION
NOT USED.
@ ASF1_FLOCKER
flocks to a leader kAI
@ ASF1_CANNOTCAUSEAFIGHT
if another actor was damaged by this actor with this flag set then other actor will not target this a...
@ ASF1_USEWEAKATTACKS
anim_aiAltMelee1
@ ASF1_LEADER
Flocker ai run toward Leaders to get attention.
@ ASF1_RANDOMRESURRECTION
NOT USED.
@ ASF1_DIEONEXPLOSION
NOT USED.
@ ASF1_PROJECTILEATTACK1
High Priest Flame Attack (anim_aiRangeAttack1)
@ ASF1_NOREPEATEXPLOSION
NOT USED.
@ ASF1_EXPLOSIONDEATH
NOT USED.
@ ASF1_AVOIDWATER
sets AF_AVOIDWATER on SetSpawnParams
@ ASF1_MELTONDEATH
allows melt effect and regeneration
@ ASF1_RESPAWNANIMATION
Enables respawning animation effect.
@ ASF1_TELEPORTAVOIDWATER
@ ASF1_TELEPORTWAIT
allows enemy to move around for 1.5 - 4.5 seconds before teleporting back in.
@ ASF1_TRIGGERSTUFF
Sets AF_TRIGGERSTUFF on SetupSpawnParams.
@ ASF1_USESTRONGATTACKS
anim_aiMelee1
@ ASF1_TELEPORT
allows kAI to teleport on SetupAISpawnFlags
@ AAF_ENTERCRAWL
Exactly the same as AAF_CRAWL except actors won't collide with this sector when CF_ALLOWCRAWL is not ...
@ AAF_REPEATABLE
Unused. In the original game this is used in combination with AAF_EVENT and will only trigger the eve...
@ AAF_CLIMB
climb up sectors faster than AAF_LADDER
@ AAF_ENTERED
Not shown in Editor. Used in kex editor only for fill sector commands. When map is saved in kex edito...
@ AAF_WARPRETURN
In Remaster it's used as a PlayerBlocking sector. used with clipflag CF_COLLIDEPLAYERBLOCKER.
@ AAF_LADDER
climb up sectors slower than AAF_CLIMB
@ AAF_RESTRICTED
kAI can't enter the area
@ AAF_STOREWARPRETURN
Unused.
@ AAF_SLOPETEST
overrides AAF_CLIFF flag. If the sectors floor plane up direction is <= 0.5 then is a wall (a wall is...
@ AAF_TOGGLE
if on and AAF_BLOCK is on then sectors won't be marked on automap until it's unblocked....
kColor kexColor_Tab20Dark(uint i)
Not used. (garbage from kexengine)
float Pow(float x, float y)
Returns f raised to power p.
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,...
int Clamp(const int i, const int min, const int max)
Returns clamped value between min and max.
int SysRand()
Range 0..32767.
const float i2f(const int i)
int to IEEE 754 float
const kVec3 vecZero(0.0f, 0.0f, 0.0f)
float ATan2(float y, float x)
Returns the angle in radians whose Tan is y/x.
int kexRandInt()
Range -2147483648..2147483647.
@ ASF2_DROPITEM_MASK6
Small Health.
@ ASF2_DROPITEM_MASK3
Medium Health.
@ ASF2_PROJECTILEATTACK8
High Priest Homing Blue Flame (anim_aiRangeAttack4)
@ ASF2_DROPITEM_MASK11
Shotgun Shells.
@ ASF2_DROPITEM_MASK14
Clip.
@ ASF2_DROPITEM_MASK12
Energy Cell.
@ ASF2_WARPDEATH
NOT USED.
@ ASF2_NOAUTOMAPDRAW
if map all or show enemies cheats are on then will not draw this actor on the automap.
@ ASF2_DROPITEM_MASK1
Explosive shells.
@ ASF2_DROPITEM_MASK5
Ultra Health.
@ ASF2_PROJECTILEATTACK3
crouch rifle Fire (anim_aiRangeAttack7)
@ ASF2_PROJECTILEATTACK4
(anim_aiRangeAttack8)
@ ASF2_STAYINWATER
sets AF_STAYINWATER on SetSpawnParams
@ ASF2_DROPITEM_MASK10
4 Rockets
@ ASF2_HOLDTRIGGERANIMATION
@ ASF2_DROPITEM_MASK13
Large Energy Cell.
@ ASF2_DROPITEM_MASK2
Grenade.
@ ASF2_STOREWARPRETURN
Used in portal scripts.
@ ASF2_ALTERNATEMOVES
is for holding two handed weapons
@ ASF2_MORTALWOUNDIMPACT
Can be hit by a super arrow shot and if ASF2_DROPITEM_MASK9 is on has a chance to drop a mortal wound...
@ ASF2_DROPITEMONDAMAGE
NOT USED.
@ ASF2_DROPITEM_MASK4
Full Health.
@ ASF2_PROJECTILEATTACK7
Grenade Throw (anim_aiRangeAttack3)
@ ASF2_PROJECTILEATTACK5
Stand Rifle Fire (anim_aiRangeAttack5)
@ ASF2_PROJECTILEATTACK6
Pipe Blow (anim_aiRangeAttack6)
@ ASF2_DROPITEM_MASK8
Minigun ammo.
@ ASF2_DROPITEM_MASK9
Mortal Wound.
@ ASF2_DROPITEM_MASK7
Large Health.
@ ASF2_REMOVEONCOMPLETION
Sets AF_REMOVEONCOMPLETION.
void kStrSplitClear()
clear the list of split strings after your done. Not required to call because it gets cleared when yo...
@ CAMS_FADEBACK_TO_CLIENT
float CosArc(const float t)
return (-((Cos(Deg2Rad(360.0f * t)) - 1.0f) * 0.5f));
int Rand()
Range 0..32767.
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.
uint8 RandByte()
Range 0..255.
float Cos(float f)
Returns the cosine of angle f in radians.
float Max(const float a, const float b)
Returns the largest of the two values.
class kScriptTMap Sin(float f)
Returns the sine of angle f in radians.
float Deg2Rad(float degs)
Degrees-to-radians conversion.
@ CMF_CHANGE_MAP_AFTER_FADE
@ CMF_SHOW_HIDDEN_OBJECTS
@ CMF_UNLOCK_PLAYER_ON_FINISH
@ CMF_NO_SUNLENSFLARE
Doesn't force the sun lens flare always on. Sun lens flare will work normally, using the "Always Show...
float Clampf(const float f, const float min, const float max)
Returns clamped value between min and max.
kStr kStrSplitGet(const int index)
returns the string at index
@ AIF_NOTHINK
don't run ai logic
@ AIF_ATTACKING
playing an attacking animation
@ AIF_WAITFORCYCLE
prevent other animations from interrupting until the current one finishes
@ AIF_NOCHASE
disable chase logic
@ AIF_TELEPORTING
in teleport state. ignore all chase logic
@ AIF_BLOWNAWAY
being blown away by explosion
@ AIF_RUNNING
Is playing running animation.
@ AIF_TELEPORTIN
playing teleport in animation
@ AIF_TELEPORTAWAY
playing teleport out animation
@ AIF_TELEPORTMOVESLOW
chasing while underground
@ AIF_DAMAGEPANIC
become aggressive when target is outside its active threshold (good for forcing AI to attack their ta...
void delay(const float time)
used in map scripts to delay execution of script
float Fabs(float f)
Returns the absolute value of f.
float HermiteBlend(const float a, const float b, const float t)
kActorFactory ActorFactory
float RandFloat()
Range 0..1.
< Not used (garbage included automatically from kexengine)
const kColor magenta
255, 0, 255, 255
const kColor blue
0, 0, 255, 255
const kColor gray
127, 127, 127, 255
const kColor tab20purple2
const kColor green
0, 255, 0, 255
const kColor white
255, 255, 255, 255
const kColor red
255, 0, 0, 255
const kColor cyan
0, 255, 255, 255
const kColor yellow
255, 255, 0, 255
const kColor tab20orange2
const kColor orange
255, 127, 0, 255
const kColor transparent
0, 0, 0, 0
const kColor black
0, 0, 0, 255
funcdef bool less(const ?&in a, const ?&in b)
sorting function for sort
void resize(uint length)
Sets the new length of the array.
void insertAt(uint index, const T &in value)
Inserts a new element into the array at the specified index.
void sortAsc()
Sorts the elements in the array in ascending order. For object types, this will use the type's opCmp ...
void removeLast()
Removes the last element of the array.
int find(uint startAt, const T &in value) const
Returns the index of the first element that has the same value as the wanted value....
int findByRef(const T &in value) const
Searches for a matching address. These are especially useful for arrays of handles where specific ins...
void reverse()
Reverses the order of the elements in the array.
void removeRange(uint start, uint count)
Removes count elements starting from start.
uint length() const
Returns the length of the array.
void removeAt(uint index)
Removes the element at the specified index.
int find(const T &in value) const
Returns the index of the first element that has the same value as the wanted value....
void insertAt(uint index, const T[]&inout arr)
Inserts another array of elements into the array at the specified index.
void insertLast(const T &in value)
Appends an element at the end of the array.
void reserve(uint length)
const T & opIndex(uint index) const
void sortDesc()
Sorts the elements in the array in descending order. For object types, this will use the type's opCmp...
bool opEquals(const T[]&in) const
void sortDesc(uint startAt, uint count)
Sorts only the elements starting at index startAt and the following count elements in the array in de...
int findByRef(uint startAt, const T &in value) const
Searches for a matching address. These are especially useful for arrays of handles where specific ins...
void sort(less &in, uint startAt=0, uint count=uint(- 1))
sorts array using the passed in less function
T &[] opAssign(const T[]&in)
void sortAsc(uint startAt, uint count)
Sorts only the elements starting at index startAt and the following count elements in the array in as...
kStr & ToUpper()
Converts string to upper case characters.
bool IsEmpty() const
length of string is 0
kStr opAdd(uint16 i) const
bool ContainsNoCase(const kStr &in) const
contains the string ignoring case
kStr ReplaceSubstr(const kStr &in from, const kStr &in to) const
Returns a new kStr that replaced all occurrences of from with to.
int8 & opIndex(const uint64 i)
Get/Set the ASCII code of the character at the strings index.
kStr & ToLower()
Converts string to lower case characters.
kStr opAdd(uint64 i) const
bool opEquals(const kStr &in s) const
bool Contains(const kStr &in) const
contains the string
float Atof() const
Converts string to float.
uint64 Length() const
Returns the length of the string.
kStr opAdd(float f) const
kStr opAdd(int16 i) const
kStr opAdd(const kStr &in s) const
kStr Substr(uint64 start, uint64 length) const
Return a substring from the current string. Will return the current string if start or length indexes...
kStr & opAddAssign(bool b)
kStr opAdd(int64 i) const
const int8 opIndex(const uint64 i) const
Returns the ASCII code of the character at the strings index.
bool StartsWith(const kStr &in s) const
Returns true if this string starts with s.
int Atoi() const
Converts string to int.
uint Hash() const
Returns HashID from this instance.
kStr & opAddAssign(const kStr &in s)
kStr & opAssign(const kStr &in s)
uint64 IndexOf(const kStr &in s) const
Reports the zero-based index of the first occurrence of a specified string within this instance....
bool EndsWith(const kStr &in s) const
Returns true if this string ends with s.
kAngle & opAssign(const float f)
kAngle opSub(const float f) const
kAngle(const kAngle &in other)
kAngle & opAssign(const kAngle &in a)
float Diff(const float rads) const
kAngle & opSubAssign(const float f)
float Interpolate(const float a, const float b) const
float Diff(const kAngle &in other) const
kAngle & opAddAssign(const kAngle &in a)
kAngle & opAddAssign(const float f)
kAngle opAdd(const kAngle &in a) const
kAngle opSub(const kAngle &in a) const
kAngle & opSubAssign(kAngle &in a)
kAngle opAdd(const float f) const
Representation of 3D vectors and points.
kVec3 opAdd(const kVec3 &in v) const
kVec3 & opAssign(const kVec3 &in v)
kVec3 Cross(const kVec3 &in v) const
Cross Product of two vectors.
kVec3 opMul(const float val)
kVec3 & QuadraticCurve(const kVec3 &in pt1, const float value, const kVec3 &in pt2, const kVec3 &in pt3)
kVec3(float x, float y, float z)
float Length() const
Returns the length of this vector. Exactly the same as Unit()
float ToYaw()
Returns the Yaw direction in Rads.
void Set(const float x, const float y, const float z)
Set x, y and z components of this kVec3.
kVec3 opSub(const kVec3 &in v) const
kVec3 & CubicCurve(const kVec3 &in pt1, const float value, const kVec3 &in pt2)
kVec3 & opSubAssign(const kVec3 &in v)
kVec3 opDiv(const kVec3 &in v)
kVec3 & Normalize()
Makes this vector have a magnitude of 1.
kVec3 & Randomize(const float value)
Randomizes x, y, z, components by value.
kVec3 opDiv(const float val)
kVec3 & opAddAssign(const kVec3 &in v)
kVec3 & opDivAssign(const float f)
float Distance(const kVec3 &in other) const
Returns the distance between this instance and other vector.
kVec3 & opMulAssign(const kVec3 &in v)
kVec3 opMul(const kQuat &in rot) const
float LengthSq() const
Returns the squared length of this vector. Exactly the same as UnitSq()
kVec3 & opMulAssign(const float f)
kVec3 Lerp(const kVec3 &in other, const float t) const
Linearly interpolates between two vectors.
float UnitSq() const
Returns the squared length of this vector. Exactly the same as LengthSq()
kVec3 & Lerp(const kVec3 &in other, const float t)
Linearly interpolates between two vectors.
float ToPitch()
Returns the Pitch direction in Rads.
float opIndex(int i) const
kVec3 opAdd(const float f) const
kVec3 opSub(const float f) const
kVec3 & Project(const kVec3 &in normal, const float value)
Projects a vector onto another vector.
kVec3 & opMulAssign(const kQuat &in rot)
kVec3 & opAddAssign(const float f)
kVec3 & opDivAssign(const kVec3 &in v)
kVec3 opMul(const kVec3 &in v)
kVec3 & Reflect(const kVec3 &in normal, const float energyFactor)
Reflects a vector off the plane defined by a normal.
float DistanceSq(const kVec3 &in other) const
Returns the squared distance between this instance and other.
float Unit() const
Returns the length of this vector. Exactly the same as Length()
kQuat ToQuaternion() const
kVec3 & opSubAssign(const float f)
void Clear()
Sets x, y and z components to 0.
float Dot(const kVec3 &in v) const
Dot Product of two vectors.
Quaternions used to represent rotations.
void GetAngles(float &out yaw, float &out pitch, float &out roll)
kQuat & NormalizeNoInvSqrt()
void Set(const float x, const float y, const float z, const float w)
kQuat(float angle, float x, float y, float z)
kQuat Diff(const kQuat &in rot) const
void Clear()
x,y,z = 0.0 w = 1.0
kQuat opSub(const kQuat &in rot)
kQuat(float rotX, float rotY, float rotZ)
kQuat & opAssign(const kQuat &in rot)
kQuat(const kQuat &in other)
kQuat & opMulAssign(const kQuat &in rot)
kQuat(float angle, kVec3 &in vector)
kQuat opAdd(const kQuat &in rot)
kQuat opMul(const kQuat &in rot)
kQuat Slerp(const kQuat &in rot, float t) const
float ToYaw() const
Yaw of this plane.
const kVec3 & Normal() const
float Distance(const kVec3 &in point) const
0 = PSIDE_ON. > 0 is PSIDE_FRONT. < 0 PSIDE_BACK.
kPlane(const float a, const float b, const float c, const float d)
float Dot(const kVec3 &in point) const
bool IsFacing(const float yaw) const
Returns true if yaw is facing toward the plane. Usually used for climbing sectors.
kPlane(const kVec3 &in a, const kVec3 &in b, const kVec3 &in c)
float Dot(const kPlane &in plane) const
kPlane(const kAngle &in a)
const int PointOnSide(const kVec3 &in point) const
Returns EnumPlaneSide. If point is in front, behind or on the plane.
kPlane(const kVec3 &in a, const kVec3 &in b)
< Not used (included automatically from kexengine)
kColor(float r, float g, float b)
kColor opSub(const kColor &in c) const
kColor(const kColor &in rgb, uint8 a)
kColor & opAssign(const kColor &in c)
void FromVec3(const kVec3 &in v)
void HSLToRGB(float hue, float sat, float lit)
void RGBToHSV(float &out hue, float &out sat, float &out result) const
kColor & opMulAssign(const kColor &in c)
kColor opMul(float f) const
kColor opAdd(const kColor &in c) const
kColor opMul(const kColor &in c) const
void RGBToHSL(float &out hue, float &out sat, float &out lit) const
kColor(uint8 r, uint8 g, uint8 b, uint8 a)
kColor & opSubAssign(const kColor &in c)
kColor & opAddAssign(const kColor &in c)
float GetSaturation() const
kColor(const kColor &in c)
kColor(uint8 rgb, uint8 a)
bool opEquals(const kColor &in c) const
void HSVToRGB(float hue, float sat, float val)
kVec3 ToVec3Linear() const
float GetLuminance() const
kColor ToPreMultiplied() const
void FromVec3Linear(const kVec3 &in v)
kColor & opMulAssign(float f)
void SetSaturation(float)
void LerpRGB(const kColor &in c, float t)
< Not used (garbage included automatically from kexengine)
bool WriteByte(const uint8 i)
< Not used (garbage included automatically from kexengine)
kStr GetGroupString(int key, uint groupIndex, uint plat) const
plat: kexLocPlatform_e
kStr TranslateGroupString(const kStr &in key, uint groupIndex, uint plat) const
plat: kexLocPlatform_e
kStr GetString(const kStr &in key, kexLocPlatform_e plat) const
kStr TranslateStringWithArgs(const kStr &in key, const kDict &in pairs, uint plat) const
plat: kexLocPlatform_e
uint GetGroupIndex(const kStr &in groupName)
kStr GetGroupString(const kStr &in key, uint groupIndex, uint plat) const
plat: kexLocPlatform_e
kStr TranslateGroupStringWithArgs(const kStr &in key, const kDict &in pairs, uint groupIndex, uint plat) const
plat: kexLocPlatform_e
kStr TranslateString(const kStr &in key, kexLocPlatform_e plat) const
kStr GetString(int key, kexLocPlatform_e plat) const
kStr TranslateString(const kStr &in key) const
Same as Game.GetLocalizedText.
bool opEquals(const ref &in) const
ref & opHndlAssign(const ?&in)
bool opEquals(const ?&in) const
ref & opHndlAssign(const ref &in)
ref obj
Access to ScriptObject class script obj ref. Should never be null.
ref obj
Access to ScriptObjectFx class script obj ref. Should never be null.
Actor script classes must inherit from this class.
void OnCollisionStart()
Collision Movement Check is starting.
void OnMenuTick()
called only when dummymenu active
void OnCollide(kCModel@)
called even if alseep
void OnRemoved()
called when actor is removed (Internally or through scripting). IsStale will return true immediately ...
void OnPreDamage(kActor @instigator, kDictMem @damageDef, const int damage)
always called when damaged even after death. Call OverrideOnDamageValue on the actor if you need to o...
void OnTouch(kActor @theActorThatTouchedMe)
called even if alseep
void OnDeactivate()
Never used.
void OnDamage(kActor @instigator, kDictMem @damageDef, const int damage)
always called even after death
void OnCollisionFinish()
Collision Movement Check has ended.
void OnDeath(kActor @killer, kDictMem @damageDef)
called only when actor dies
Weapon script classes must inherit from this class.
void OnBeginFire()
Required.
void OnEndFire()
Required.
void OnHoldster()
Required.
Player script class must inherit from this class.
void OnPickup(kActor @pickup)
void OnArmorDamage(kActor @instigator, kDictMem @damageDef, const int damage)
Fx script class must inherit from this class.
void OnExpire()
Called OnTick.
bool OnImpactFloor(int impactType, const kVec3 &in normal)
bool OnImpactWall(int impactType, const kVec3 &in normal)
void OnCollide(kCModel @pCModel)
Called just before any of the OnImpact functions (except water).
void OnImpactWater()
Called OnTick after Fx Movement update.
void OnCollidePost()
Called right after OnCollide and the OnImpact functions (except water).
void OnRemoved()
called when actor is removed (Internally or through scripting). IsStale will return true immediately ...
void OnCollisionFinish()
Collision Movement Check has ended.
bool OnImpactObject(int impactType, int impactDmgType, kActor@ actor, const kVec3 &in normal)
void OnCollisionStart()
Collision Movement Check is starting.
bool OnImpactCeiling(int impactType, const kVec3 &in normal)
Editable Dictionary object that holds keys and values.
void SetValue(const kStr &in key, const kStr &in value)
Sets the value for the specified key.
void Empty()
Removes all keys/values.
bool GetBool(const kStr &in key, bool &out boolResult, const bool defaultValue=false)
Returns true if found the key as a bool type.
void Add(const kStr &in key, const kStr &in value)
Adds a new key/value.
bool GetInt(const kStr &in key, int &out intResult, const int defaultValue=0)
Returns true if found the key as a int type.
bool GetString(const kStr &in key, kStr &out stringResult)
Returns true if found the key as a kStr type.
bool GetVector(const kStr &in key, kVec3 &out vectorResult)
Returns true if found the key as a kVec3 type.
bool GetFloat(const kStr &in key, float &out floatResult, const float defaultValue=0)
Returns true if found the key as a float type.
const bool HasKey(const kStr &in key)
Returns true if key exists.
Read only Dictionary object that holds keys and values.
bool GetVector(const kStr &in key, kVec3 &out vectorResult)
Returns true if found the key as a kVec3 type.
bool GetBool(const kStr &in key, bool &out boolResult, const bool defaultValue=false)
Returns true if found the key as a bool type.
bool GetFloat(const kStr &in key, float &out floatResult, const float defaultValue=0)
Returns true if found the key as a float type.
bool GetString(const kStr &in key, kStr &out stringResult)
Returns true if found the key as a kStr type.
bool GetInt(const kStr &in key, int &out intResult, const int defaultValue=0)
Returns true if found the key as a int type.
const uint GetNumEntries() const
returns number of items in the list
kSelectionListInt & opAssign(const kSelectionListInt &in other)
void AddItem(int item, const int weight)
void Reset()
clears all items in the list
int & Select()
Returns a value based on item weights.
kSelectionListFloat & opAssign(const kSelectionListFloat &in other)
const uint GetNumEntries() const
returns number of items in the list
void AddItem(float item, const int weight)
void Reset()
clears all items in the list
float & Select()
Returns a value based on item weights.
void SetVisibility(const int nodeIndex, const bool visible)
kVec3 GetNodeScale(const int node)
kQuat GetNodeRotation(const int node)
Is calculated on draw. Can call ForceUpdateJoints if you need the current value for interpolation.
const int GetNumNodes() const
kVec3 GetNodeOrigin(const int node, const kVec3 &in offset)
Is calculated on draw. Can call ForceUpdateJoints if you need the current value for interpolation.
void HideSection(const int nodeIndex, const int section, const bool hide)
section is the surface index. must be 0-31 and must not be >= number of surfaces or will do nothing.
void ColorOverrideSections(const int node, const int sectionMask=-1)
enable the color override for specific sections(materials) on the node by setting each bit....
void SetMorphUpdating(const bool bUpdate)
Set Morph Updating.
void SetMorphFrame(const int frame, const int nextFrame, const float time)
void SetTexture(const int section, const int textureID)
void SetRotationOffset(const int nodeIndex, const float rads, const float x, const float y, const float z, const bool clearInterpolation=false)
void AddTrailEffect(const kStr &in trailName, const int nodeIndex)
const bool IsMorph() const
void ColorOverride(const int node, const float r=1.0f, const float g=1.0f, const float b=1.0f, const float a=1.0f)
color values range from -1.0f to 1.0f. Call ColorOverrideSections to enable the override for sections...
void SetRotationOffset(const int nodeIndex, const kQuat &in rotation, const bool clearInterpolation=false)
const int GetNumAttachedTrails()
void ForceUpdateJoints(const float interpolatedFraction=1.0f)
Force update node matrices and then call GetNodeOrigin/GetNodeRotation to get current value....
void GetMorphFrame(int &out frame, int &out nextFrame, int &out maxFrames, float &out time) const
Get Morph frame info.
void SetModel(const kStr &in modelPath, const kStr &in modelAnimPath)
kStr GetModelFile() const
void ScaleOverride(const int node, const kVec3 &in scale)
void RemoveTrailEffect()
Removes all trail effects.
const float TrackTime()
time from 0(on first frame) to 1(on last frame).
const bool CycleCompleted() const
(flags & ANF_CYCLECOMPLETED) != 0
const int LoopFrame()
The frame the animation loops back to when it reaches the last frame. Returns -1 if no animation set.
void Blend(const int animID, float speed, float blend, int flags)
EnumAnimStateFlags.
kVec3 rootMotion
the move direction of the root node from the prev frame to the current frame.
const int GetAnimNumFrames(const int animID)
void Set(const int animID, float speed, int flags)
EnumAnimStateFlags.
kVec3 GetOrigin(const int animID, int nodeNum, int frame)
void Stop()
flags |= ANF_STOPPED; flags &= ~ANF_LOOP;
const int NumFrames()
number of frames in this animation. Returns -1 if no animation set.
const int CurrentFrame()
current frame playing for the current animation. Must have an animation action keyframe for this to w...
void Set(const int animID, float speed, int flags, const int frame, const bool runActions=true, const bool noSoundActions=false)
EnumAnimStateFlags. Sets the animation to the frame while optionally running all previous actions.
void Resume()
flags &= ~ANF_PAUSED;
const float PlayTime()
increases by GAME_DELTA_TIME if not stopped or paused.
void Pause()
flags |= ANF_PAUSED;
const int TrackNextFrame(void) const
next frame to play for the current animation.
void SetPlayTime(const float time)
The total time in seconds this animation has been playing.
void SetLastFrame(const bool execActions=false)
if execActions is true, runs all key frame actions in the animation except Footstep(55) and PlaySound...
const bool Looping() const
(flags & ANF_LOOP) != 0
kQuat GetRotation(const int animID, int nodeNum, int frame)
const bool Blending() const
(flags & ANF_BLEND) != 0
int flags
EnumAnimStateFlags.
float baseOffset
is somewhat the Z position of the root node. It's calculated as follows whenever the root motion is u...
const bool Stopped() const
(flags & ANF_STOPPED) != 0
bool IsPlaying(const int animID)
Returns true if current animations ID is animID and the animation is not stopped.
void Blend(const int animID, float speed, float blend, int flags, const int frame, const bool runActions=true, const bool noSoundActions=false)
EnumAnimStateFlags. Blends the animation to the frame while optionally running all previous actions.
void SetTrackTime(const float time)
0.0(first frame) to 1.0(last frame)
bool CheckAnimID(const int animID)
checks if animID exists
void ChangeSpeed(const float speed)
Scales speed of the current animation where 1.0 = 15fps and 4.0 = 60fps.
const int NumNodes()
number of nodes in this animation. Returns -1 if no animation set.
const int PlayingID() const
the current animations ID
const int TrackFrame(void) const
current frame playing for the current animation.
Base type used by all actors.
bool & DrawDelay()
Don't draw until has ticked once.
kVec3 GetTransformedVector(const kVec3 &in vector)
kVec3 DamageOrigin(void) const
The Origin point of the attacker (Fx, Actor, or null (returns this actors origin in that case)) who d...
int & DifficultyMode()
The difficulty this actor is currently set to.
void SetSpawnFlags3(const uint flags)
EnumActorSpawnFlags3.
kFx DamageFx() const
The kFx that hit this actor. Will be null if no Fx hit this actor. Only use in OnPreDamage/OnDamage/O...
const int16 SpawnParams(const int paramID) const
Get a map actors param value.
const bool GetUsingCustomDeadHeight()
const int MapActorIndex() const
Returns -1 if not a map actor.
void SetModel(kStr &in modelFile, kStr &in animFile)
a way to set the model/anim for actors that had no model set previously
void SetDecayTime(const float value)
Used to melt kAI when they regen. Value range should be 0 (normal) to 60 (fully melted).
const int16 GetOverrideKeyTouchTID()
used only for key pickups
bool & NoKnockBack()
Will not receive knock back movement from things like the alien weapon for example.
bool & UseNewExplosiveRadiusCheck(void)
(default False) Set to true to enable explosive damage checks from radius to actor cylinder(more accu...
float & Mass()
default = GAME_SCALE * 1.0f
kAngle & PrevLerpYaw(void)
kAI CastToAI()
Casts to kAI. returns null if isn't a kAI.
int & ImpactType()
EnumImpactType.
void SetCustomDeadHeight(const bool bUse, const float height)
Height of actor when they are dead. Only for non map actors. (actors spawned with ActorFactory)
float SoundPlayTime(const kStr &in file, const uint index=0)
returns -1.0f if sound is not playing. Returns the amount of time in seconds the sound has been playi...
const float GetWaterHeight() const
kVec3 DamageVelocity(void) const
The Velocity of the attacker (Fx, Actor, or null (returns this actors velocity in that case)) who dam...
bool FxEventActive()
Returns true if ActorFx is running.
float DistanceToPoint(const float x, const float y, const float z) const
actors point is in the center
bool & IgnoreSectorPlatformChange(void)
if true this actor will not change position(or velocity and movement) when sector platform moves.
const float GetCustomDeadHeight()
void ClearCustomRef(void)
Allows the actor to get freed from memory if it has no references. This will be called automatically ...
kDictMem Definition()
get actors def data
bool CheckPosition(const float angle, const float distance)
calls CheckPosition(kVec3 origin) with origin being: Actor.Origin() + (angle*distance*Actor....
float & WaterFriction()
default = 0.5f (same as Friction)
void Remove()
Removes the actor and sets stale to true. Actor will only internally be removed when there are no ref...
void GetBoundsMinMax(kVec3 &out min, kVec3 &out max) const
actor must not be sleeping and have a model set and not be a pickup. otherwise will return default mi...
void LinkArea()
Links the actor to an area node so that internally the actor can be found in quick searches (similar ...
void SetPosition(const kVec3 &in pos, const bool clearInterpolation=true)
best way to set an actors position (if you don't know the sector), will also set the sector and optio...
const bool InWater() const
void SetSector(const uint sectorIndex)
void SetCurrentGameSpeed(const float speed)
Set Gamespeed of this Actor (default 1.0f)
kAngle & PrevLerpPitch(void)
void InflictGenericDamage(kActor@ inflictor, const kStr &damageDef, const int damage)
Can pass in a damage def. The damageDef keys used are mainly for custom scripting purposes only....
bool & IgnoreSectorHeightChange(void)
if true will not change position(or velocity and movement) when sector height changes.
const bool OverridingKeyTouchTID()
used only for key pickups
void OverrideOnDamageValue(const int damage, const bool bOverride=true)
call in OnPreDamage
kFx SpawnProjectile(const kStr &in fxPath, const kVec3 &in pos, const kVec3 &in targetLocation, const float maxAngle)
Returns the first Fx spawned. targetLocation.z gets added by GAME_SCALE * 3.0f.
float RadiusDamageFactor(const kVec3 &in origin, const float radius) const
int & ImpactTypeDmg()
EnumImpactType. Overrides the damage def used. if is -1 (default) then does not override ImpactType()
void SetSpawnParams(const int param, const int16 value)
Sets the actors param value. all params are int16.
void SetAutomapColor(const int r, const int g, const int b)
kFx SpawnFx(const kStr &in fxPath, const kVec3 &in pos)
const float GetGameSpeed() const
Returns CurrentGameSpeed if IgnoreGameSpeed is true else returns CurrentGameSpeed * GlobalGameSpeed.
const bool CanSee(kPuppet@ puppet, const uint excludeClipFlags=0)
excludeClipFlags to ignore/disable (EnumClipFlags). Note: This function that takes in the kPuppet arg...
kScriptObject ScriptObject()
Returns the ScriptObject that holds the obj ref to the custom script. Will return null if actor doesn...
void ClearFxEvent()
Clears all data for the actors ActorFx on this actor.
kFx SpawnFx(const kStr &in fxPath, const kVec3 &in pos, const kQuat &in rot)
uint & ClipFlags()
EnumClipFlags.
kRenderModel RenderModel()
kAngle & PrevLerpRoll(void)
kActor CastToActor()
Casts to a kActor. Only used for kPuppet Actor().
void InflictGenericDamage(kActor@ inflictor, const int damage)
void SetHeadTrackTarget(kActor@ actor)
void SetupSpawnParams()
call after setting your actors spawnflags for them to take effect on the kActor
bool InstanceOf(const kStr &in className) const
example: InstanceOf("kexPuppet")
void InteractActorsAtPosition(const kVec3 &in pos, const kStr &in callbackFunc, const float arg1=0, const float arg2=0, const float arg3=0, const float arg4=0)
Calls a script function on all actors that are in the AreaNodes (KD-Tree search) contained inside a b...
void SetTarget(kActor@ actor)
const float BaseHeight() const
height of actor when spawned or when kAI regenerated
const bool CanSee(kActor@ actor, const uint excludeClipFlags=0)
excludeClipFlags to ignore/disable (EnumClipFlags)
bool CheckPosition(const kVec3 &in origin)
checks if the actor can move to this location
void SetSpawnFlags2(const uint flags)
EnumActorSpawnFlags2.
void AutomapToggle(const bool show)
Use with Game.AutomapCustom(true);.
const bool IsPersistentMarked()
float & PrevLerpFloorHeight(void)
void InflictDamage(kActor@ inflictor, const kStr &in damageDef)
const int GetSectorIndexAtLocation(const kVec3 &in pos, uint excludeClipFlags=0)
excludeClipFlags to ignore/disable (EnumClipFlags)
const bool MoveToPosition(const float x, const float y, uint clipFlags)
EnumClipFlags to use. Returns True if new position is in the same sector as the actor else returns fa...
kVec3 & PrevLerpOrigin(void)
const float GetCurrentGameSpeed(void) const
Gamespeed of this Actor (default 1.0f)
const uint SpawnFlags2() const
EnumActorSpawnFlags2.
const float DecayTime(void)
Value used to melt kAI when they regen. Values range from 0.0 (normal) to 60.0 (fully melted).
bool & IgnoreGameSpeed()
GameSpeed used for this actor will be CurrentGameSpeed. (Default is true for kPuppet and kPlayerWeapo...
void SetupHeadTrack(const kStr &in headTrackDef)
Sets a headtrack.
void RotateAroundOrigin(const kAngle &in angle, const kVec3 &in platformOrigin, const bool setPos=true)
The angle amount to rotate this actors position. if setPos is true will use SetPosition to position t...
const float GetFloorHeight() const
calculates the floor height from the actors sector and origin. Returns 0 if not in a sector.
const bool IsStale() const
Actor is marked as removed and is waiting to be freed from memory when it next checks if there are no...
int GetWaterLevel() const
EnumWaterLevel.
bool & ChildOfTarget(void)
if this actors Target is an actor that belongs to the owner of the Fx, explosion or melee attack then...
void RunFxEvent(const kStr &in fxEventName)
Runs an ActorFX event. Example: RunFxEvent("Enemy_Freeze");.
void MeleeObject(const kStr &in damageType, const kVec3 &in offset, const float radius)
uint & Flags()
EnumActorFlags.
const bool MoveToPosition(const float x, const float y)
Returns True if new position is in the same sector as the actor else returns false and it set a new s...
const uint SpawnFlags3() const
EnumActorSpawnFlags3.
void PlaySound(const kStr &in soundPath)
float & StepHeight()
AKA Dead Height. Used for moving up steps, figuring out if in waterheight, and the height of the acto...
float DistanceToPoint(const kVec3 &in point) const
calls DistanceToPoint(x,y,z)
kVec3 & Origin()
Position in world space.
const float GetSkyHeight() const
int & Type()
The actors Type ID.
void CheckLinkArea()
If origin or radius changed since the last LinkArea then calls LinkArea else does nothing....
const float GetCeilingHeight() const
calculates the ceiling height from the actors sector and origin. Returns 0 if not in a sector.
void RunAction(const int funcID, const float w=0.0f, const float x=0.0f, const float y=0.0f, const float z=0.0f)
run a function on the actor defined in defs/animActions.txt
kQuat & PrevLerpRotation(void)
void ClearInterpolation()
bool & SkipKeyTouchCinema()
used only for key pickups
void PlaySoundWithLookupID(const int soundID)
bool & TriggerInvincibility()
Can't damage if true. Gets set to true if enemy has trigger anim and false when activated.
bool RandomDecision(const int randomBit) const
randomBit should be >= 2. if a random value has the bit set and actors GameTicks also has the bit set...
bool & IgnoreFxGameSpeed()
GameSpeed used for Fx whose source is this actor will always be CurrentGameSpeed. (Default is false)
bool & RemoveTrailsOnAnimChange()
Will remove all model trails on this actor when animation is set/blend.
const uint SpawnFlags1() const
EnumActorSpawnFlags1.
float GetTurnYaw(const kVec3 &in lookAtLocation) const
void AddCustomRef(void)
Keeps the actor from getting freed from memory.
bool HasCustomRef(void) const
const int RefCount() const
Returns the number of references there are to this actor. If actor is stale and RefCount is 0 then it...
float & SoundPitchModify()
Override the final pitch of sounds owned by this actor. A value of 1000 raises the pitch by the amoun...
void SetSpawnFlags1(const uint flags)
EnumActorSpawnFlags1.
const int GameTicks() const
void MarkPersistentBit(const bool clear)
float GetAvoidanceAngle(const kVec3 &in lookAtLocation, const float distance)
float & AirFriction()
default = 1.0f
void OverrideKeyTouchTID(const bool bOverride, const int16 tid)
used only for key pickups to tell what key it is in the hub
kActor Get()
Returns the next actor in the iterator.
void Reset()
Resets the iterator back to the first actor.
float & PlaySpeed()
Get/Set speed of weapon animations (default = 4.0f)
float & FOV()
Get/Set weapon FOV (default = 47.5f)
kFx FireProjectile(const kStr &in fxPath, const float x, const float y, const float z, const bool adjustToPerspective=false)
SpawnsFx at the players at the position passed in * players rotation, then adds the viewHeight + land...
bool & NoGenericBobbing()
Disables the generic weapon bobbing menu option from affecting this weapon.
kVec3 TransformToOwnerPosition()
returns the OffsetPosition() * the players matrix.
kVec3 TransformToOwnerPosition(const kVec3 &in vector)
returns the (OffsetPosition() + vector) * the players matrix.
bool & ClearInterpolationOffsetPosition()
Set to true to clear the OffsetPosition interpolation after the weapon ticks, then it gets set back t...
bool & NoWalkAnim()
Get/Set the usage of the walk anim. Run animation will be used instead.
float & PlaySpeedSwapIn()
Get/Set speed of weapon lower animation (default = 4.0f)
int & State()
EnumWeaponStates.
float & PlaySpeedSwapOut()
Get/Set speed of weapon raise animation (default = 3.0f)
bool & ForceGenericBobbing()
bool & PreventFire()
Use in OnBeginFire to internally prevent from entering its Fire state.
bool & AllowUnderwater()
Set to true to allow the weapon underwater. Gets reset back to the weapons def value after OnBeginLev...
kVec3 & OffsetPosition()
Offset position of weapon.
float & AttackRange()
squared
float & SightRange()
squared
int & Agitation()
0-300. 0-99=IDLE, 100-199=AGITATED, 200-300=CHASE
float & SightFOV()
in rads
float & AnimScalar()
default = 1.0f
float & QuietRange()
squared
float & BlendScalar()
default = 10.0f
int & AttackChance()
0-100
void SetupAISpawnFlags()
call after setting your actors spawnflags for them to take effect on the kAI
float & LeashRadius()
squared
int & Regenerate()
get/set current number of times the enemy will regenerate value. Regenerate is set right after OnBegi...
uint & AIFlags()
EnumAIFlags.
float & MeleeRange()
squared
float & FlyHeight()
squared
float & LoudRange()
squared
const float GroundStrafeSpeed() const
default = 10.24f
void SetJumpClimbSpeed(const float speed)
default = GAME_SCALE * 0.2875f
const float JumpMinSpeed() const
default = GAME_SCALE * 0.855f
const float StrafeBobScale() const
void SetGroundBackwardAccel(const float accel)
default = 0.05f
const float LandingViewOffset() const
LandingViewOffset changes when jumping and falling. Origin.z + ViewHeight() + LandingViewOffset() = C...
kVec3 & CustomViewOrigin()
const float GroundBackwardAccel() const
default = 0.05f
float & Oxygen()
Time in seconds. 0: full oxygen. >= 55: shows air bar. >= 70: OxygenOut is set to true.
void SetSwimBackwardSpeed(const float speed)
default = -10.24f
const int GetMaxLifeforces() const
void SetUnderwaterBobScale(const float scale)
kAngle & CustomViewPitch()
void SetGroundBackwardSpeed(const float speed)
default = -10.24f
void SetOverrideWalkRun(const int value)
0=none(default), 1=Force Disable Walk
const float TurnBobScale() const
const float WalkMaxSpeed() const
default = 4.0f
void SetSwimForwardAccel(const float accel)
default = 0.05f
const float GroundDeaccel() const
default = 0.5f
void SetHeadBobScale(const float scale)
const int OverrideShadow() const
default = 0
void SetGroundStrafeAccel(const float accel)
default = 0.05f
const float GroundForwardSpeed() const
default = 10.24f
const float GroundForwardAccel() const
default = 0.05f
void SetJumpMaxSpeed(const float speed)
default = GAME_SCALE * 1.667f
const int GetMaxLives() const
void SetStrafeBobScale(const float scale)
uint & PlayerFlags()
EnumPlayerFlags.
void SetWalkMaxSpeed(const float speed)
default = 4.0f
void SetGroundForwardSpeed(const float speed)
default = 10.24f
const float GroundStrafeAccel() const
default = 0.05f
void SetGroundStrafeSpeed(const float speed)
default = 10.24f
float & RecoilPitch()
used for weapon recoil that modifies the players pitch.
kAngle & CustomViewRoll()
const float SwimBackwardAccel() const
default = 0.05f
void SetOverrideWeaponOnTopFix(const int value)
0=none(default), 1=Force disable fix, 2=Force enable fix (can use console command "g_weaponontopfix" ...
const float SwimForwardSpeed() const
default = 10.24f
void SetSwimBackwardAccel(const float accel)
default = 0.05f
void SetCrawl(const bool crawl)
use this to manually set if the player is crawling instead of setting PF_CRAWLING directly.
void SetGroundDeaccel(const float accel)
default = 0.5f
void SetSwimForwardSpeed(const float speed)
default = 10.24f
float & OverrideFOV()
set to 1-179. anything else will stop overriding the fov and will use the r_fov cvar.
void SetMaxLifeforces(const int value)
Amount of Lifeforces needed to get an extra life.
void SetJumpMinSpeed(const float speed)
default = GAME_SCALE * 0.855f
const float SwimStrafeAccel() const
default = 0.05f
const float JumpMaxSpeed() const
default = GAME_SCALE * 1.667f
const int OverrideWalkRun() const
default = 0
void SetSwimStrafeAccel(const float accel)
default = 0.05f
const float SwimStrafeSpeed() const
default = 10.24f
void SetSwimDeaccel(const float accel)
default = 0.5f
void SetSwimStrafeSpeed(const float speed)
default = 10.24f
const float ClimbJumpAmount() const
default = GAME_SCALE * 0.2875f
bool & CustomViewUnderwater()
whether the custom view is underwater or not
const int OverrideWeaponOnTopFix() const
void SetMaxLives(const int value)
Max lives allowed from gaining Lifeforces.
void SetJumpBobScale(const float scale)
const float JumpBobScale() const
bool & NoWallJump(void)
default = false
void SetTurnBobScale(const float scale)
void SetGroundForwardAccel(const float accel)
default = 0.05f
const float SwimBackwardSpeed() const
default = -10.24f
float & MaxFallVelocity(void)
default = -200.0f
const float GroundBackwardSpeed() const
default = -10.24f
const float SwimDeaccel() const
default = 0.5f
const int GetState(void) const
EnumPlayerStates.
void SetOverrideShadow(const int value)
0=none(default), 1=Force Disable shadow, 2=Force Enable shadow
bool & CustomViewEnable()
Set to true to enable the custom view.
const float UnderwaterBobScale() const
const float SwimForwardAccel() const
default = 0.05f
float & ViewHeight()
set from the players def "player.viewHeight". Origin.z + ViewHeight() + LandingViewOffset() = Cameras...
bool & OxygenOut()
if true will damage player if underwater
const float HeadBobScale() const
kActor Spawn(const kStr &in actorName, const float x, const float y, const float z, const float yaw, const int sector=- 1)
kActor Spawn(const int actorID, const float x, const float y, const float z, const float yaw, const int sector=- 1)
bool InfoSourceDead() const
const int FxIndex() const
The index in the fx file array.
kVec3 InfoMuzzleOffset() const
float InfoSaturationRandom() const
bool InfoOverrideMaxDrawScale() const
void GetColor1(float &out r, float &out g, float &out b, float &out a)
Get the color values.
kStr InfoUserString() const
Custom use.
bool InfoAddOffset() const
void LinkArea()
Links the Fx to an area node so that internally the fx can be found in quick searches (similar to a k...
bool InfoAttachSourceAnimOffset() const
bool InfoProjectile() const
kActor GetOwnerAsActor()
Returns null if is not an Actor.
int InfoFadeinTime() const
int InfoClipFlagsExclude() const
void SpawnWaterImpactFx()
float InfoRotationSpeed() const
bool InfoNoSpawnFar() const
bool InfoStopAnimOnImpact() const
bool InfoNoDirection() const
float InfoRestart() const
const int InstanceIndex() const
float InfoHueRandom() const
float InfoRotationPivotY() const
const float GetWaterHeight() const
bool InfoNoSpawnNear() const
int & ImpactType()
EnumImpactType.
bool InfoDepthBuffer() const
kVec3 InfoTranslation() const
kVec3 & VelocityOffset()
When Fx spawns this is set to the starting velocity of the Fx. And adds to velocity if bAddOffset is ...
void Remove()
Removes the Fx and sets stale to true. Fx will only internally be removed when there are no reference...
const int BounceCount() const
const float GetSkyHeight() const
float RadiusDamageFactor(const kVec3 &in origin, const float radius) const
void GetColor2(float &out r, float &out g, float &out b, float &out a)
Get the color values.
float & Height()
(Default 8.0) Not really used. Only for searches for the fx to define it's bounding box.
void SpawnImpactFx(const int impactType, const kVec3 &in normal, const bool bUseEvent=true, const bool bBlood=true)
bool & DoUpdateMovement()
If set to false the Fx will not move.
bool InfoMuzzleEffect() const
const bool CanSee(kActor@ actor, const uint excludeClipFlags=0)
excludeClipFlags to ignore/disable (EnumClipFlags)
int InfoClipFlagsInclude() const
float InfoAirFriction() const
bool InfoNoWallSpawn() const
int InfoUserID() const
Custom use.
bool InfoActorInstance() const
float DistanceToPoint(const kVec3 &in point) const
calls DistanceToPoint(x,y,z)
bool InfoAttachSource() const
bool InfoIgnoreGameSpeed() const
bool & DoUpdateExpireCheck()
If set to false the Fx will not expire and get removed when lifetime is over.
int & Frame()
The sprite frame. Make sure this value is < MaxFrames().
void SetTarget(kActor@ actor)
float & Radius()
(Default 8.0) Not really used. Only for searches for the fx to define it's bounding box.
float InfoSpawnDistOffset() const
const bool DrawDelay() const
kScriptObjectFx ScriptObject()
Returns the ScriptObject that holds the obj ref to the custom script. Will return null if kFx doesn't...
bool InfoDecalOffset() const
const bool SwapBloodColor() const
Is true if fx has bBlood set to true and games blood menu option is set to Green(1)....
bool InfoBounceImpact() const
void ClearCustomRef()
Allows the Fx to get freed from memory if it has no references. This will be called automatically whe...
bool & OnCollideForceNoSetOriginToLast()
If set to true the Fx will never set it's origin and sector to what it was before OnCollide was calle...
uint & ClipFlagsExclude()
ClipFlags to always exclude on Fx movement collision.
float InfoMaxscale() const
int & ImpactTypeDmg()
EnumImpactType. Overrides the damage def used. if is -1 (default) then does not override ImpactType()
bool & DoUpdateScaling()
If set to false the Fx will not update draw scale.
float & RotationOffset()
Current Rotation Offset around the Y Axis. kQuat(RotationOffset(), 0.0f, 1.0f, 0.0f);.
bool InfoSourceAlive() const
int InfoOnCollideWall() const
bool & ChildOfTarget()
Unused. Only used for kActors.
void SetColor2(float r, float g, float b, float a)
Values range from 0.0 to 1.0. Environment color of the sprite (used in shaders to blend color1 and co...
void SetColor1(float r, float g, float b, float a)
Values range from 0.0 to 1.0. Color and alpha of sprite.
const float GetFloorHeight() const
calculates the floor height from the Fx sector and origin. Returns 0 if not in a sector.
float InfoWaterFriction() const
bool InfoFullScreen() const
const int RefCount() const
Returns the number of references there are to this Fx. If this Fx is stale and RefCount is 0 then it ...
void SetParentFx(kFx@ fx)
float & FrameTime()
The current time left before the Fx sprite tries going to the next frame in the sprite.
void SetOwnerAsFx(kFx@ fx)
int InfoFadeoutTime() const
bool & DoUpdateFading()
If set to false the Fx will not update color1 and color2 alpha value.
float & DrawScaleDest()
When the Fx is updating its scale OnTick, the current draw scale will increase to this value in diffe...
bool InfoStickOnTarget() const
bool InfoLensFlares() const
bool InfoDrawOnBottom() const
float & MaxDrawScale()
The highest value the DrawScale() can become when the Fx is updating its scale OnTick.
kFx GetOwnerAsFx()
Returns null if is not an Fx.
float & Speed()
Initial forward moving speed, set on spawn from forwardSpeed and forwardSpeedRandom in the fx file.
float DistanceToPoint(const float x, const float y, const float z) const
Fx point is in the center.
const float Distance() const
Distance to the center of the View (Player or Camera) at the time the Fx spawned.
int InfoOnCollideActor() const
const float Restart() const
Current delay time before the Fx will start ticking.
bool InfoPerPolyCollision() const
bool & OnCollideForceSetOriginToLast()
If set to true the Fx will set it's origin and sector to what it was before OnCollide was called.
float InfoRotationPivotX() const
float InfoBounceImpactThreshold() const
int InfoAnimspeed() const
bool InfoNoGroundSpawn() const
const float GetCurrentGameSpeed(void) const
Gamespeed of this Fx (default 1.0f)
int GetWaterLevel() const
EnumWaterLevel.
const int GameTicks() const
float & MovingForce()
initial velocity.Length() value. if bBullet is true then while updating movement OnTick,...
kVec3 InfoBlackColor() const
int InfoMaxInstances() const
bool & DoUpdateRotation()
If set to false the Fx will not update rotation offset.
kAngle & Pitch()
Not used by the Fx.
bool InfoRestrictAim() const
float InfoBrightnessRandom() const
void PlaySoundWithLookupID(const int soundID)
bool InfoOffsetFromFloor() const
bool InfoNoHitSource() const
float & DrawScale()
Current scale of the sprite.
float InfoScaleDest() const
const bool MoveToPosition(const float x, const float y)
Returns True if new position is in the same sector as the actor else returns false and it set a new s...
const int Instances() const
Same as the instances value in the fx file.
void SetSector(const uint sectorIndex)
float InfoRotationOffset() const
bool InfoImpactEffect() const
kVec3 InfoWhiteColor() const
kAngle & Roll()
Not used by the Fx.
kStr InfoAnimName() const
Custom use.
const bool MoveToPosition(const float x, const float y, uint clipFlags)
EnumClipFlags to use. Returns True if new position is in the same sector as the actor else returns fa...
float InfoForward() const
const float GetGameSpeed() const
Returns CurrentGameSpeed if IgnoreGameSpeed is true else returns the CurrentGameSpeed * GlobalGameSpe...
bool HasCustomRef() const
float InfoFriction() const
float InfoAnimFriction() const
float & RecurseLifeTime()
void SetPosition(const kVec3 &in pos, const bool clearInterpolation=true)
best way to set an Fx position without knowing the sector, will also find/set the sector and optional...
bool InfoFadeout(void) const
void PlaySound(const kStr &in soundPath)
void AddCustomRef()
Keeps the Fx from getting freed from memory.
bool InfoDrawDelay() const
float & RotationSpeed()
Adds this value * (0.25 * GameSpeed) to RotationOffset() when updating rotation OnTick....
int InfoOnCollideFloor() const
bool InfoTextureWrapMirrorWidth() const
float InfoNoSpawnNearFarDist() const
bool & IgnoreSectorHeightChange()
const bool IsStale() const
Fx is marked as removed and is waiting to be freed from memory when it next checks if there are no mo...
kStr InfoModelName() const
Custom use.
bool InstanceOf(const kStr &in className) const
example: InstanceOf("kexFx")
float InfoGravity() const
int InfoMaxBulletBounces() const
bool InfoTextureWrapMirrorHeight() const
uint & ClipFlagsInclude()
ClipFlags to always include on Fx movement collision.
void SetCurrentGameSpeed(const float speed)
Set the Gamespeed of this Fx (default 1.0f)
int InfoRecurseLifetime() const
const int GetSectorIndexAtLocation(const kVec3 &in pos, uint excludeClipFlags=0)
excludeClipFlags to ignore/disable (EnumClipFlags)
int InfoVisibilityType() const
kAngle & Yaw()
Not used by the Fx.
void CheckLinkArea()
If origin or radius changed since the last LinkArea then calls LinkArea else does nothing....
const float GetCeilingHeight() const
calculates the ceiling height from the Fx sector and origin. Returns 0 if not in a sector.
void ClearInterpolation()
bool InfoDestroyOnNoWater() const
bool InfoScaleLerp() const
void SetOwnerAsActor(kActor@ actor)
float InfoTranslationGlobalRandomScale() const
bool InfoDestroyOnWaterSurface() const
bool InfoWeaponView() const
bool & DoUpdateSpriteAnimation()
If set to false the Fx will not update sprite frame.
bool InfoCrossFade() const
bool & DoUpdateTickEvents()
If set to false the Fx will not call Tick or WaterTick events.
const uint MaxFrames() const
MaxFrames the sprite has. Frame should be < this value.
bool & IgnoreGameSpeed()
GameSpeed used for this Fx will always be CurrentGameSpeed. (Default = false)
const int CinematicState() const
EnumCameraStates.
void SetLookAtActor(kActor@ actor)
void TweenRotationTrack(const int view, const kVec3 &in pos, const float time)
Lerps all variables set when SetRotationTrack was called using the time param (clamped 0....
const bool Enabled() const
CinematicState() >= CAMS_FADEOUT (Not Idle)
void ZoomEyeViewToPosition(const kVec3 &in position, const float speed)
linear lerp finalview eye position to position using speed. finalview must be set or will do nothing.
void StartCinematic(const uint flags=(CMF_LOCK_PLAYER|CMF_UNLOCK_PLAYER_ON_FINISH))
EnumCameraFlags.
void SetEyeView(const kVec3 &in position)
position of camera (finalview). finalview must be set or will do nothing.
void ZoomFocusViewToPosition(const kVec3 &in position, const float speed)
linear lerp finalview focus position to position using speed. finalview must be set or will do nothin...
kVec3 origin
current position of camera. if a finalview is set then the origin will be set to the finalview's eye ...
kAngle pitch
if a finalview is set then the pitch will be set to the finalview's look direction.
void SetFinalView(const int view)
the view to use for the camera origin and direction. view must be in range 0-2
void ClearViewTracks()
views 0-2 all variables are set to 0
const bool Active() const
bool & ClearInterpolationOnTick(void)
set to false to handle interpolation yourself
void SetFocusView(const kVec3 &in position)
position of where the camera (finalview) is looking at. (Sets look direction from eye and focus posit...
float lookZOffset
Used only if LookAtActor has been set.
void SetFlags(const uint flags)
EnumCameraFlags.
void SetPositionTrack(const int view, const kVec3 &in startEye, const kVec3 &in destEye, const kVec3 &in startFocus, const kVec3 &in endFocus)
Sets eye and focus start and dest positions for use with TweenPositionTrack and AutoPlayPositionTrack...
const bool ViewingFromCamera() const
CinematicState() >= CAMS_FADEIN && CinematicState() <= CAMS_ACTIVE_TO_FADEOUT.
void SetRotationTrack(const int view, const float startAngle, const float destAngle, const float startDist, const float destDist, const float startEyeZOffset=0, const float destEyeZOffset=0, const float startFocusZOffset=0, const float destFocusZOffset=0)
Use with TweenRotationTrack and AutoPlayRotationTrack.
void StopCinematic(const bool noFade=false)
if noFade is true will stop the cinematic immediately without fading out.
void TweenPositionTrack(const int view, const float time)
Lerps eye and focus positions to the start and dest positions using the time param (clamped 0....
kVec3 & Tremor()
x = adds to yaw, y = adds to pitch, z = adds to roll. lerps to vecZero using lerpTime of GAME_FRAME_T...
void SetSector(const uint sectorIndex)
kAngle roll
if a finalview is set then the roll will be set to 0.
float fov
Camera FOV (default is 74.0)
kAngle yaw
if a finalview is set then the yaw will be set to the finalview's look direction.
kVec3 GetEyeView()
position of camera (finalview). finalview must be set or will return vecZero.
void SetUserInterrupted(const bool toggle)
set to false to set the user interrupted to false.
const uint Flags() const
EnumCameraFlags.
void AutoPlayPositionTrack(const int view, const float speed, const int lerpType)
EnumCameraLerpType. Calls TweenPositionTrack on the view using speed and lerpType.
kVec3 GetFocusView()
position of where the camera (finalview) is looking at. finalview must be set or will return vecZero.
const bool UserInterrupted() const
User pressed left click or escape key or any controller button. While CinematicState() == CAMS_ACTIVE...
void AutoPlayBlendTrack(const int viewA, const int viewB, const int viewC, const float speed, const int lerpType)
EnumCameraLerpType. Blends between viewB and viewC eye and focus. and sets the results to viewA.
bool & AllowMenusWhenActive(void)
set to true to allow the pause menu to be opened during a cinematic
void ClearInterpolation()
void SetRotateEyeVector(const kVec3 &in vector)
The focus position that is used when AutoPlayRotationTrack is called if there is no LookAtActor set.
void ClearFinalView()
finalview is set to null
void AutoPlayRotationTrack(const int view, const float speed, const int lerpType)
EnumCameraLerpType. Calls TweenRotationTrack on the view using speed and lerpType.
The kCModel(CModel) global stores collision results when certain actor methods are called....
kVec3 & ContactNormal()
Returns the normalized vector of the collided surface.
kActor ContactActor()
handle pointer to actor that was collided (null if none was collided)
const uint ClipResult()
specifies the type of intersection (flags. EnumClipResultFlags)
kVec3 & InterceptVector()
Returns the vector that intersected the collided geometry.
kVec3 & MoveDirection()
Movement vector of the object.
const float & Fraction()
returns the 0.0 - 1.0 range of the point of intersection from start to end trace. (If fraction is == ...
void StartWarp(kActor@ actor, const int tagID, const int mapID)
void TagActorForBossBar(kActor@ actor)
void ClearWarpInterpolation(void)
Clearing the interpolation for kPuppet will also clear the warp interpolation.
const bool CheckWarping()
Checks if Warping or FreeWarping is in progress.
const int UnscaledTicks() const
Not affected by GameSpeed.
void HandlePlayerDeath(const bool loseLife=true)
if loseLife is true and infinite lives cheat is off then player loses a life. if player lives is < 0 ...
const bool CanOpenSaveMenu()
Checks if it's okay to be able to open the save menu.
const float Ticksf(void) const
affected by gamespeed
void CheckKeys()
Prints HUD messages to tell the player how many keys they've found on the current HUBID.
void ChangeMap(const kStr &in mapName)
const int NewMapWarpTID()
Returns the warp TID the player warped to from another map. Returns -1 if didn't warp from another ma...
void StartFreeWarp(kActor@ actor, const kVec3 &in origin, const float yaw, const int sectorIndex, const int mapID)
const int Ticks() const
affected by gamespeed (Ticksf truncated)
const bool CanOpenPauseMenu()
Checks if it's okay to be able to open a menu.
const bool GetCvarValue(const kStr &in cvarName, kStr &out result)
void MouseToHUD(float &out x, float &out y)
Returns the HUD position of the mouse.
void MouseToHUDNoStretch(float &out x, float &out y)
Returns the HUD position of the mouse.
void Warning(const kStr &in message)
void Print(const kStr &in message)
void FloodMatchingAreaFlags(const int sectorIndex, const uint flags, const bool active)
(EnumAreaFlags) Sets flags on all adjacent sectors with matching areaID.
void ChangeAreaWallImpact(const int areaID, const int value)
value: EnumImpactType
const int GetAreaAmbience(const int area) const
const int GetAreaFloorImpact(const int areaID) const
EnumImpactType.
const float GetAreaWaterZFar(const int area) const
const int GetNumSectors() const
const float GetAreaWaterHeight(const int area) const
const int GetNumAreas() const
void ChangeAreaFloorImpact(const int areaID, const int value)
value: EnumImpactType
void FloodFillAreaFlags(const kVec3 &in origin, const uint flags, const bool active)
(EnumAreaFlags) Calls FloodMatchingAreaFlags with FindNextClosestSector(origin) sector.
const float GetAreaBlendLength(const int area) const
the speed to interpolate the fog color/start/zfar values when they change
const int GetSectorDrawOrder(const int sectorIndex) const
lowest draw order (0) draws the sectors on the automap last
const int GetSectorBridge(const int sectorIndex, const uint bridge) const
Get the sector of the bridge. Use GetSectorNumBridges to loop through them all.
void SetSectorFlags(const int sectorIndex, const int flags)
Keep in mind sector flags are a 16 bit unsigned integer and only the first 16 area flags (up to AAF_M...
kActor GetActorByTID(const int tagID, const int typeFilter=- 1) const
if typeFilter is -1 checks any type otherwise only returns the actor of that type
const int GetNumActors() const
number of actors that are in the current maps data
void OverrideWaterFogColor(const int r, const int g, const int b)
rgb values are 0-255
void GetSectorVertIndices(const int sectorIndex, int &v1, int &v2, int &v3) const
Get the Sectors vertex indices. If invalid sectorIndex is passed in will return all -1.
void ChangeAreaArg(const int areaID, const int arg, const int16 value)
const float GetAreaFogZFar(const int area) const
void ChangeSectorCeilingHeight(const int sectorIndex, const float height)
Changes all sectors ceiling vertices with the same areaID to the height.
const int GetAreaCullBits(const int area) const
if any staticmeshes cullBits have any of the area cullBits set then it will draw. (default callbits i...
void OverrideFogColor(const int r, const int g, const int b)
rgb values are 0-255
kActor GetActorByType(const int typeFilter) const
Returns the first map actor of the same type.
void SetAreaFogColor(const int area, const kVec3 &in color)
color values are in range 0-255
void SetAreaWaterColor(const int area, const kVec3 &in color)
color values are in range 0-255
void SetAreaMapColor(const int area, const int color)
const int GetSectorAreaID(const int sectorIndex) const
const uint GetAreaFlags(const int areaID) const
EnumAreaFlags.
const int GetSectorFlags(const int sectorIndex) const
Returns a 16 bit unsigned integer. Only the first 16 area flags (up to AAF_MAPPED) are used for secto...
void ChangeSectorHeightVertices(const int sectorIndex, const float height, const int ptMask=7)
Changes only the sector floor vertices(specified using the ptMask) to the height.
const kStr GetSkyMaterial() const
void GetSectorLinks(const int sectorIndex, int &out sectorIndex1, int &out sectorIndex2, int &out sectorIndex3) const
Get the 3 sectors links. -1 means there was no sector linked to that edge. Link 1 is pt1 to pt3 Link ...
void FloodFillAreaFlags(const int sectorIndex, const uint flags, const bool active)
(EnumAreaFlags) Sets flags on all adjacent sectors until it finds a sector that has the flags already...
void ChangeAreaFlag(const int areaID, const uint flags, const bool active)
(EnumAreaFlags) Only sets the areaID flags and not the sector flags. Should most likely prefer using ...
const int FindNextClosestSector(const kVec3 &in origin)
Returns the sector that this point is best in. Returns -1 if not inside and above/on a sector.
void SetAreaAmbience(const int area, const int ambience)
const int FindClosestSectorByDistance(const kVec3 &in origin)
Returns the closest sector. Will return -1 only if the map contains no sectors.
const float GetAreaSkySpeed(const int area) const
speed scale is this value / 100. 100 is normal speed.
const kVec3 GetAreaWaterColor(const int area) const
color values are in range 0-255
const int GetAreaWallImpact(const int areaID) const
EnumImpactType.
const int GetAreaMusic(const int area) const
void SetSectorDrawOrder(const int sectorIndex, const int drawOrder)
lowest draw order (0) draws the sectors on the automap last
void ChangeSectorCeilingHeightVertices(const int sectorIndex, const float height, const int ptMask=7)
Changes only the sector ceiling vertices(specified using the ptMask) to the height.
const int GetAreaMapColor(const int area) const
void SetAreaWaterZFar(const int area, const float zfar)
void ChangeSectorHeight(const int sectorIndex, const float height)
Changes all sectors floor vertices with the same areaID to the height.
void OverrideSkyMaterial(const kStr &in path)
Example path: "skies/skyMaterials/sky_brown" You can clear the sky with an empty string: "" Do not pa...
const bool PointInsideSector(const int sectorIndex, const kVec3 &in point) const
Returns true if point is inside the sector (XY only)
void SetAreaFogZFar(const int area, const float zfar)
void SetAreaSkyHeight(const int area, const float height)
void SetAreaCullBits(const int area, const int bits)
if any staticmeshes cullBits have any of the area cullBits set then it will draw. (default callbits i...
void SetAreaMusic(const int area, const int music)
const uint GetSectorNumBridges(const int sectorIndex) const
number of bridge sectors this sector has
const int16 GetAreaArg(const int areaID, const int arg) const
Returns an area arg value.
void ChangeAreaWaterHeight(const int areaID, const float height)
WaterHeight is stored per area, not per sector or per vertex.
bool TriggerActorsByTID(kActor@ instigator, const int tagID)
Triggers an actor (that is not the instigator) that has the same tagID. Returns true if triggered an ...
void SetAreaSkySpeed(const int area, const float speed)
speed scale is this value / 100. 100 is normal speed.
const kVec3 GetAreaFogColor(const int area) const
color values are in range 0-255
void ClearOverrideWaterFogColor()
Stops overriding and uses the sector color.
void GetSectorCorners(const int sectorIndex, kVec3 &out pt1, kVec3 &out pt2, kVec3 &out pt3, kVec3 &out heights) const
Get the Sectors vertex position and height Link 1 is pt1 to pt3 Link 2 is pt2 to pt1 Link 3 is pt3 to...
void ClearOverrideFogColor()
Stops overriding and uses the sector color.
const float GetAreaSkyHeight(const int area) const
void MoveSectorPlatform(const int sectorIndex, const kVec3 &in moveDelta, const uint flags=SPF_DEFAULT)
EnumSectorPlatformFlags. Moves bridge sectors vertices not connected to non bridge sectors by moveDel...
void SetAreaBlendLength(const int area, const float blendLength)
a blendLength value of 1.0 interpolates the fog color/start/zfar values at 0.066666 (1/15) per tick.
const int GetCurrentMapID()
void StopTactile(int vibHandle)
void Print(const kStr &in text, const int ticks=120)
Print a message to the HUD on the next line.
kStr GetLocalizedText(const kStr &in key)
bool SphereInView(const kVec3 &in origin, const float radius)
bool SetTextFlags(const int id, const int flags)
EnumCustomHUDFlags.
void OverrideRespawningEnemies(const int value)
Set: Game.OverrideRespawningEnemies(); Get: GameVariables.GetInt("OverrideRespawningEnemies",...
void LifeForcePulse()
Shows the LifeForces on the HUD.
kStr GetHubTitle(int hubID)
Returns the HUB's Title def property. Returns empty string if not found.
bool EnemiesAlwaysDropItems()
Returns the gameplay menu option value.
void SetWorldSunDirection(const float x, const float y, const float z)
const bool IsFrozenObjects()
Returns true if the freezeobjects console command is enabled.
kStr GetCommandBind(const kStr &in command, const bool first=true, const bool sort=true)
Returns the key bind name of the console command. Returns empty string if nothing is bound.
void SaveMenu()
Opens the save game menu. Should always check if(PlayLoop.CanOpenSaveMenu())
bool SetWeaponWheelPic(const int weapon, const kStr &in imagePath)
void SetPickupFlash()
Shows the pickup screen flash.
void SetModBindings(const bool show=true)
Shows custom mod bindings in menu Bindings > Actions.
bool & NoArmorFlash(void)
kStr GetFxFile(const int fxID)
Returns the file path to the Fx by ID value as defined in defs/fileLookup.txt.
void SetPreventOpenPauseMenu(const bool value)
void OpenHeadBobbingMenu()
bool SetPicColor(const int id, const int r=255, const int g=255, const int b=255, const int a=255)
const float GetMaxZDrawDistance()
Returns GetExtraZFar + the max z-draw distance from the active map def.
void HaltMapScript(const int scriptID)
bool IsTactilePlaying(int vibHandle, const kStr &in path)
void ScreenPointToHUD(float sx, float sy, float &out x, float &out y)
Returns the HUD position of the screen point.
void ClearTextInterpolation(const int id)
void OverrideFogType(const int value)
0=none, 1=force Radial, 2=force Plane
void OverridePerPolyCollision(const int value)
0=none, 1=force disable, 2=force enable
void OpenWeaponBindingsMenu()
void PlayMovie(const kStr &in filename, const bool skippable=true)
Only .ogv or .webm files (replaces/adds extension to filename automatically). Can not read from kpfs.
int PlayTactile(const kStr &in path, int channel, int pos)
Start controller vibration from tactile sound file. Returns a handle.
bool SetPicUV(const int id, const float s1=0.0f, const float t1=0.0f, const float s2=1.0f, const float t2=1.0f)
bool & HideAmmo()
Hide ammo display on the HUD.
float GetHUDOffset(const bool user=false)
if user is false will return the width to the edge of the screen (negative value)....
void ShowPauseMenu()
Should always check if(PlayLoop.CanOpenPauseMenu())
void AutomapDeactive(const bool toggle)
permanently deactivates the automap.
bool GetHubKeyInfo(const uint hubID, int &out nKeys, int &out remainingKeys, int &out keyBits)
bool IsTactilePlaying(int vibHandle)
void SetCursorHotPos(int x, int y)
change the mouses cursors click point (default is 0, 0)
bool & HideCrosshair()
Hide Crosshair display on the HUD.
void ScreenPointToHUDNoStretch(float sx, float sy, float &out x, float &out y)
Returns the HUD position of the screen point.
bool IsCheatActive(const int cheatBits)
EnumCheatFlags. Returns true if cheats are active.
void AddText(const int id, const int font, const kStr &in text, const float x, const float y, const int edge=0, const float scale=1.0f, const bool center=false, const bool shadow=false, const int r=255, const int g=255, const int b=255, const int a=255, const int r2=255, const int g2=255, const int b2=255, const int a2=255)
add custom text to the HUD. HUD size is 640x480 (pillar box). AddPic must be done in OnPostBeginLevel...
bool BoxInView(const kVec3 &in min, const kVec3 &in max)
bool IsJoystickActive()
if true the players last input was from a controller.
const int BossDamageScaler(const int difficulty, const int damage)
bool SetPicEdge(const int id, const int edge)
edge 1=left side 2=right side (for convenience. You can set to 0 and offset x position with GetHUDOff...
bool SetPicWH(const int id, const float w, const float h)
bool SetTextColors(const int id, const int r=255, const int g=255, const int b=255, const int a=255, const int r2=255, const int g2=255, const int b2=255, const int a2=255)
const bool IsActorPersistentMarked(const int actorIndex, const int hubID=-1, const int mapNum=0)
an invalid hub or map uses current maps persistent data.
void OverrideBloom(const int value)
0=none, 1=force disable, 2=force enable
kStr GetInputImagePath(const kStr &in bindName)
void PrintLine(const kStr &in text, const int lineNumber, const int ticks=120)
Print a message to the HUD.
kFx SpawnFx(const kStr &in fxPath, kActor@ source, const kVec3 &in velocity, const kVec3 &in origin, const kQuat &in rotation)
void LivesPulse()
Shows the Lives on the HUD.
void PrintHelp(const kStr &in text, const bool endGame=false)
void SetNoModSelect(const bool bToggle=true)
Disable the mod select menu when selecting new game for workshop mods only. (seta g_nomodselect "1")
bool SetHubKey(const uint hubID, int keyBits, int remainingKeys)
Set the keybits and remainingKeys directly.
bool LoadModFile(const kStr &in filename)
Loads a custom save file. make sure to call GameModFileData.Empty() after you're done loading.
void GetSectorInBounds(const kVec3 &in min, const kVec3 &in max)
The array of sectors is stored in Game.GetSectorResult. (KD-Tree search)
void OpenMenuBindingsMenu()
bool SetPicAngle(const int id, const float angle)
in rads
void CallDelayedMapScript(const kStr &in funcName, kActor@ instigator, const float delay)
even with delay 0 it will be called when map scripts update
bool SetPicFlags(const int id, const int flags)
EnumCustomHUDFlags.
void SetGlobalSoundPitch(const float pitch)
When sounds begin to play their pitch is scaled by this value.
kFx SpawnFx(const kStr &in fxPath, kPuppet@ source, const kVec3 &in velocity, const kVec3 &in origin, const kQuat &in rotation)
const int GetMapNumberFromName(const kStr &in mapName)
This returns the HUB number NOT the map number. mapName is the HUB name such as "Map_Jungle"....
void NextSoundPitchScale(const float pitch)
The next play sound will scale the pitch by this much.
bool InputImageExists(const kStr &in path)
void NextSpawnFxSetResults()
On the next call to SpawnFx or any other function that calls SpawnFx (such as SpawnProjectile and Fir...
bool SetTextProps(const int id, const float scale, const int font=0, const int edge=0, const bool center=false, const bool shadow=false)
Set the text scale, font, edge, center, shadow.
void MarkActorPersistentBit(const int actorIndex, const bool clear=false, const int hubID=-1, const int mapNum=0)
an invalid hub or map uses current maps persistent data.
void ClearAllMapsPersistData(void)
Clears all sector and actor persistent data for all maps in the game.
const int GetMapIDFromName(const kStr &in mapName)
This returns the mapID from the mapName. Returns -1 if not found.
void ClearPicInterpolation(const int id)
float MusicPlayTime()
Returns the amount of time the music has been playing for in seconds. Doesn't reset back to 0 when lo...
void OpenOptionsMenu()
saves config file when exiting this menu
void SetAllSoundsPitchScale(const float pitchScale)
Sets all playing sounds pitch scale.
kStr GetHubDefName(int hubID)
Returns the HUB's def name. Returns empty string if not found.
bool & HideBossBar()
Hide BossBar display on the HUD.
void SaveModFile(const kStr &in filename)
Saves a custom save file. make sure to call GameModFileData.Empty() before adding key/values to save.
void SetDifficulty(const int value)
EnumDifficulty.
bool & NoPickupFlash(void)
void DisableLegalText()
Removes the text at the bottom of the title screen.
void AutomapToggle(const bool toggle)
show/hide the automap.
bool SetPicOrigin(const int id, const float x, const float y)
bool RemoveText(const int id)
int PurgeUnusedModels()
Returns number of models freed.
kFx SpawnFx(const kStr &in fxPath, kPuppet@ source, const kVec3 &in origin, const kQuat &in rotation)
void GetActorInBounds(const kVec3 &in min, const kVec3 &in max)
The array of actors is stored in Game.GetActorResult. (KD-Tree search). Each actors bounds is calcula...
const bool AutomapDeactived()
kFx GetFxResult(const uint index)
Use after calling Game.GetFxInBounds. Do not use at any other point!
void SetWorldSunLightColor(const float r, const float g, const float b)
void PlaySound(const kStr &in path)
uint GetActorResultsLength()
Use after calling Game.GetActorInBounds.
void AutomapCustom(const bool toggle)
allow actors with custom automap colors to be drawn to the automap. (for mods)
void ShowMainMenu(const bool mouseCenter=true)
int GetMapSecretsFound(int mapID)
Returns the number of secrets found in this map. Returns 0 if map not found.
const float ShakeIntensity()
const float GetExtraZFar()
a custom amount for modders to add to the zfar value
void SetExtraZFar(const float zfar)
affects actors, ai, particles, fog and underwater. (works normally unlike the cvar r_zfarextent)
bool CanUseCustomNoStretch()
Returns true if aspect ratio is 4:3 or bigger width.
bool & HideHealth()
Hide health display on the HUD.
bool ClearWeaponWheelPic(const int weapon)
bool IsWorkshop()
Returns true if game was run through the steam workshop (ran with command arg -workshop)
bool SetTextMsg(const int id, const kStr &in text)
void CallDelayedMapScript(const int scriptID, kActor@ instigator, const float delay)
even with delay 0 it will be called when map scripts update
int GetMapSecretBits(int mapID)
returns the secretBits found in this map. Returns 0 if map not found.
void SetPicOrder(const int id, const int order)
bool SetTextOrigin(const int id, const float x, const float y)
bool & NoDamageFlash(void)
bool & HideWeaponWheel()
Hide WeaponWheel display on the HUD.
void PlayMusicID(const int musicID, const int fadeTimeMS=500, const bool loop=true)
MusicID -2 plays previous track, -1 stops the music.
void OpenHUDOptionsMenu()
void SetDamageFlash()
Shows the damage screen flash.
void SetWorldSunAmbientColor(const float r, const float g, const float b)
uint GetSectorResultsLength()
Use after calling Game.GetSectorInBounds.
const uint ConButtons()
EnumPlayerConButtons.
void OpenActionBindingsMenu()
bool IsRunningMapScript(const int scriptID)
uint GetFxResultsLength()
Use after calling Game.GetFxInBounds.
kVec3 GetWorldSunAmbientColor()
void NextSoundVolumeScale(const float volume)
The next play sound will scale the volume by this much.
const int GetDifficulty()
EnumDifficulty. Internally calls GameVariables.GetInt("g_difficulty")
kVec3 GetWorldSunLightColor()
bool AddPic(const int id, const kStr &in path, const float x, const float y, const float w, const float h, const int edge=0, const float s1=0.0f, const float t1=0.0f, const float s2=1.0f, const float t2=1.0f, const int r=255, const int g=255, const int b=255, const int a=255)
add custom image to the HUD. HUD size is 640x480 (pillar box). AddPic must be done in OnPostBeginLeve...
bool ClearMapPersistData(int mapID)
Clears all sector and actor persistent data for the map and returns true. Returns false if map was no...
const bool AutomapEnabled()
is the automap displaying on screen
void PlayMusic(const kStr &in path, const bool loop)
Use PlayMusicID instead.
kStr GetMapNameFromID(const int mapID)
Finds the name of the map with the mapID. Returns an empty string couldn't find the map.
bool & HideLives()
Hide Lives display on the HUD.
int GetHubIDFromMapID(int mapID)
Return the HUB ID value. Returns -1 if not found.
bool SetTextColor(const int id, const int r=255, const int g=255, const int b=255, const int a=255)
void SetTextOrder(const int id, const int order)
void ClearDummyMenu(bool bClearAll=false)
void MusicPitch(const float pitch)
void GetTextSize(const kStr &in text, const int font, const float scale, float &out width, float &out height)
EnumGameFontType.
bool SetHubKey(const uint hubID, int key)
uint MenuButtons(void) const int64 GetTimestamp()
bool SetPicTex(const int id, const kStr &in path)
kFx SpawnFx(const kStr &in fxPath, kActor@ source, const kVec3 &in origin, const kQuat &in rotation)
void LoadMenu()
Opens the load game menu. Should always check if(PlayLoop.CanOpenPauseMenu())
kVec3 WorldToScreenPoint(const kVec3 &in origin)
bool & HideTimers()
Hide Timers display on the HUD.
const bool GetPreventOpenPauseMenu()
void ChangeMap(const kStr &in path)
void SetWaterReflectionViewPoint(const kVec3 &in point)
bool RemovePic(const int id)
kVec3 GetWorldSunDirection()
kFx SpawnFx(const kStr &in fxPath, kActor@ source, const kVec3 &in origin, const float yaw, const float pitch)
void CallMapScript(const int scriptID, kActor@ instigator)
Use to call map script right away.
bool & HideAirBar()
Hide AirBar display on the HUD.
float GetHUDOffsetNoStretch(const bool user=false)
if user is false will return the width to the edge of the screen (negative value)....
kDictMem GetActorDef(const kStr &in name)
Returns the Actors Def by name.
void WeaponWheelPulse()
Shows the WeaponWheel on the HUD.
void SetWaterReflectionAlpha(const float alpha)
Default is 1.0f.
kDictMem GetActorDef(const int type)
Returns the Actors Def by it's type.
void SetGameSpeed(const float speed, const float blendSpeed)
Sets the current GameSpeed. kPuppet and kPlayerWeapon are not affected by GameSpeed.
void MessageBox(const kStr &in msg1, const kStr &in msg2)
void ToggleCursor(bool b=false)
kFx SpawnFx(const kStr &in fxPath, const kVec3 &in origin, const int sectorIndex)
bool & HideLifeForces()
Hide LifeForces display on the HUD.
void SetArmorFlash()
Shows the armor damage screen flash.
kStr GetActionBind(const int action, const bool first=true, const bool sort=true)
Returns the key bind name of action. Returns empty string if nothing is bound.
void GetDateAndTime(int &out seconds, int &out minutes, int &out hours, int &out day, int &out month, int &out year, kStr &out text)
kStr PlayerName()
Returns "Player" if could not get name.
bool LoadModDataFile(const kStr &in filename)
Load any file in your mod that is a kDict binary. Use the python T1_json2modbin.py on the main script...
bool & HideHelpMessages()
Hide HelpMessages display on the HUD.
bool SetMapSecretsFound(int mapID, int secretBits)
Returns false if map could not be found. secretBits only uses the first 16 bits, that means each map ...
int GetHubSecretsFound(const uint hubID)
Returns the number of secrets found in all the maps in this HUB. Returns 0 if HUB not found.
int GetSectorResult(const uint index)
Use after calling Game.GetSectorInBounds. Do not use at any other point!
kFx SpawnFx(const kStr &in fxPath, kPuppet@ source, const kVec3 &in origin, const float yaw, const float pitch)
void OverrideSkyHeight(const float height)
Set to 0 to stop overriding.
bool & UseCustomNoStretch()
Set to true to use the non stretch Hud fix for Custom Text and Pics.
void EnableWaterReflectionViewPoint(const bool enable)
void GetFxInBounds(const kVec3 &in min, const kVec3 &in max)
The array of Fx is stored in Game.GetFxResult. (KD-Tree search). Each Fx bounds is calculated as MAX(...
bool & HideRunWalk()
Hide RunWalk display on the HUD.
void ClearPics(const bool clearImageCache=false)
void PlaySoundID(const int soundID)
bool & HideMessages()
Hide Messages display on the HUD.
void SetLivesPic(const kStr &in imagePath)
void ClearInterpolationOnGameObjects()
Clears Interpolation on all gameobjects and the camera if it's active.
kActor GetActorResult(const uint index)
Use after calling Game.GetActorInBounds. Do not use at any other point!
void OpenAutomapBindingsMenu()
void ConfirmMenu(const kStr &in msg1, const kStr &in msg2)
void RunWalkPulse()
Shows the RunWalk graphic on the HUD.
void SetLifeForcePic(const kStr &in imagePath)
void ShowDummyMenu(void)
Actors OnMenuTick function will now be processed. Call ClearDummyMenu to close the dummy menu.
void Reset()
Resets the iterator back to the first Fx.
kFx Get()
Returns the next Fx in the iterator.
void CyclePrevWeapon(const bool bCheckAmmo=false)
const bool HasAltAmmo(const int weaponID) const
const bool HasAltAmmo() const
const int16 SecretCount(void) const
Total number of secrets currently found over the entire game.
const int GetAltAmmo(const int weaponID) const
void SetCheckPoint(const int warpTID, const int map)
kWeapon GetWeaponActor(const int weapon)
int16 & ExtraHealth()
should be <= MaxExtraHealth
bool GiveAmmo(const int weapon, const int amount, const bool altAmmo)
set amount to negative values to take ammo
void Victory(const int warpActorID=- 1, const int mapID=- 1)
bool & RunWalkToggle()
if true walking is enabled. (saves)
const int CurrentCheckPoint()
returns warpTID
const int GetWeaponGroup(const int weapon)
const uint16 Buttons() const
returns EnumPlayerButtons
void SetLives(const int amount)
const float GetSpiritualTime() const
void CancelSpiritualTime(float blendTime=1.0f)
if in spirit mode then will set gamespeed back to 1.0f using the passed in blendTime
bool GiveHealth(const int amount, const bool bMortalWound)
Takes into account extra health, and max health values. 0 is full health, negative amounts give extra...
const int CurrentCheckPointMap()
void CycleNextWeapon(const bool bCheckAmmo=false)
const int PendingWeapon() const
void SetLifeForces(const int amount)
const bool SetWeaponUseAltAmmo(const int weapon, const bool bToggle)
void SetSpiritualTime(const float time, const float blend)
time = time until cancels the effect. Should SetGameSpeed after calling this.
const bool WeaponUsingAltAmmo(const int weapon) const
void ConsumeAmmo(const int ammo, const bool preferredAmmo=true)
int16 & MaxExtraHealth()
should be <= MaxHealth
const int CurrentWeapon() const
void SetSecretCount(const int amount)
Set the total number of secrets currently found over the entire game.
const bool Locked() const
uint ButtonHeldTime(const int btn)
btn type is EnumInputActions
bool & SilentCheckPoints(void)
if true won't show checkpoint message or play sound when on a checkpoint area. Gets set back to false...
const kVec3 GetButtonMovement() const
bool & NoLandClearVel()
if true, when doing a hard landing you will not lose your velocity (saves)
bool RemoveWeapon(const int weapon)
const kVec3 GetButtonAngles() const
int16 & MaxHealth()
should be >= MaxExtraHealth and ExtraHealth
void SetWeaponGroup(const int weapon, const int group)
Binds this weapon to another weapons index. Example: you made a new pistol weapon at index 14 and wan...
void ChangeWeapon(const int weapon)
const bool HasAmmo(const int weaponID, const bool checkAlt=true) const
if checkAlt is false only checks primary ammo
const bool HasWeapon(const int weaponID) const
bool GiveWeapon(const int weaponID, const int ammo, const bool switchNewWeapon=true)
returns true if gave ammo else returns false because already has full primary ammo....
float & LookSensScale()
Scales mouse/controller/gyro sensitivity (default = 1.0f)
const bool WeaponAllowUnderwater(const int weapon) const
bool & NoWeaponSwitchOnWaterLand()
will not auto switch weapon when entering/exiting water. (saves)
const int GetAmmo(const int weaponID) const
void ConsumeAltAmmo(const int ammo)
A map/dictionary that stores key/values as kStr. Example code to iterate each key/value:
bool HasKey(const kStr &in key)
Returns true if the key exists.
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.
void ItBegin()
Resets the iterator back to the first key/value.
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 Remove(const kStr &in key)
Removes the key if it exists and returns true.
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 se...
1.13.2