HPL2/Engine Scripts

2023-08-20T11:54:26Z

Krutzelpuntz: /* Quests */

{{TocRight}}

This page documents all scripts available in Amnesia: The Dark Descent.

{{note|'''Note''': Some of the functions require the Amnesia 1.3 update. Steam and other online store copies should be automatically updated. Other copies can get it [http://www.frictionalgames.com/forum/thread-24334.html here].}}

==Engine scripts==
===Main===

The following functions are the main hps functions that the HPL2 engine looks to run on certain events - similar to the C++ int main() function.

<syntaxhighlight lang="cpp">
void OnStart();
</syntaxhighlight>

The function that runs when the map is loaded for the first time.

<syntaxhighlight lang="c++">
void OnEnter();
</syntaxhighlight>

The function that runs whenever the player enters a map.

<syntaxhighlight lang="c++">
void OnLeave();
</syntaxhighlight>

The function that runs when the player leaves a map.

<syntaxhighlight lang="c++">
void OnGameStart();
</syntaxhighlight>

This function is found in the global.hps file and the inventory.hps file, and is run when the game is first started by the player (ie via "Start New Game").

===General===

<syntaxhighlight lang="c++">
float RandFloat(float afMin, float afMax);
</syntaxhighlight>

Generates a random float.

#''afMin ''- minimum value
#''afMax ''- maximum value
<syntaxhighlight lang="c++">
int RandInt(int alMin, int alMax);
</syntaxhighlight>

Generates a random int. Note: the maximum value is ''inclusive'' - the RandInt() function may return this value.

#''alMin ''- minimum value
#''alMax ''- maximum value
<syntaxhighlight lang="c++">
bool StringContains(string& asString, string& asSubString);
</syntaxhighlight>

Checks whether a string contains the specified string. Example: searching for "hello" in "hello world" would return '''true'''.

#''asString ''- the string to check
#''asSubString ''- the string to search for
<syntaxhighlight lang="cpp">
string& StringSub(string& asString, int alStart, int alCount);
</syntaxhighlight>

Returns the substring in a string. Example: in the string "frictional games rocks", using 4 as ''alStart'' and 6 as ''alCount'' would return '''"tional"'''.

#''asString ''- the string
#''alStart ''- start position in the string
#''alCount ''- amount of characters
<syntaxhighlight lang="c++">
int StringToInt(string&in asString);
</syntaxhighlight>

{{ReqVer|1.3}}

If possible, returns an integer converted from a string, else returns 0.

#''asString'' - String to convert.
<syntaxhighlight lang="c++">
float StringToFloat(string&in asString);
</syntaxhighlight>

{{ReqVer|1.3}}

If possible, returns a float converted from a string, else returns 0.

#''asString'' - String to convert.
<syntaxhighlight lang="c++">
bool StringToBool(string&in asString);
</syntaxhighlight>

{{ReqVer|1.3}}

If possible, returns a boolean converted from a string, else returns false.

#''asString'' - String to convert.

===Mathematical Operations===

<syntaxhighlight lang="c++">
float MathSin(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the sine of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathCos(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the cosine of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathTan(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the tangent of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathAsin(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the arc sine of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathAcos(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the arc cosine of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathAtan(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the arc tangent of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathAtan2(float afX, float afY);
</syntaxhighlight>

{{ReqVer|1.3}}

Calculates and returns the arc tangent of the specified values.

#''afX'' - First value to operate.
#''afY'' - Second value to operate.
<syntaxhighlight lang="c++">
float MathSqrt(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the square root of the specified value.

#''afX'' - Value to operate.
<syntaxhighlight lang="c++">
float MathPow(float afBase, float afExp);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the value of afBase raised to the power of afExp.

#''afBase'' - The base value.
#''afExp'' - Value to calculate the base with.
<syntaxhighlight lang="c++">
float MathMin(float afA, float afB);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the lowest value.

#''afA'' - First value.
#''afB'' - Second value.
<syntaxhighlight lang="c++">
float MathMax(float afA, float afB);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the highest value.

#''afA'' - First value.
#''afB'' - Second value.
<syntaxhighlight lang="c++">
float MathClamp(float afX, float afMin, float afMax);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns afX clamped between afMin and afMax. If afX < afMin, returns afMin, and if afX > afMax, returns afMax.

#''afX'' - The value to clamp.
#''afMin'' - The minimum value to clamp afX with.
#''afMax'' - The maximum value to clamp afX with.
<syntaxhighlight lang="c++">
float MathAbs(float afX);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the absolute value.

#''afX'' - Value to operate.

===Debugging===

<syntaxhighlight lang="cpp">
void Print(string& asString);
</syntaxhighlight>

Prints a string to the log file (''hpl.log'').

<syntaxhighlight lang="c++">
void AddDebugMessage(string& asString, bool abCheckForDuplicates);
</syntaxhighlight>

Prints a string to the debug console.

#''asString ''- the string to print
#''abCheckForDuplicates ''- if true, the string won't be printed more than once on screen until it disappears
<syntaxhighlight lang="c++">
void ProgLog(string& asLevel, string& asMessage);
</syntaxhighlight>

Prints an entry to the ProgLog (progression log). ProgLog is a file created in Documents/Amnesia/main (or an FC folder if one is being used). It logs certain events, such us opening the menu or picking up the lantern, as well as the player's state (Health, Sanity, Oil, Tinderboxes, Coins), for the purpose of documenting a tester's playstyle. This function allows to log custom messages.The messages in the ProgLog file are sorted by time elapsed since a map was loaded.

ProgLog has to be enabled for a player profile in ''user_settings.cfg'' before it starts working.

#''asLevel ''- can be "Low", "Medium" or "High". It's a tag which appears in each log entry, for event prioritising.
#''asMessage ''- The custom message to be printed to the log.
<syntaxhighlight lang="c++">
bool ScriptDebugOn();
</syntaxhighlight>

Checks whether the debug mode is enabled. See [[HPL2/Development_Environment|"Setting up Development Environment"]] to setup debug mode on your own computer.

===Variables===
{{warning|Regular variables (int, float, etc.) are '''not''' saved by the game. Using them in important parts of yor script will break it upon loading a game save. In HPL, those variables should only be used for disposable counters, like spawning objects in a "for" loop. For variables which need to be saved, use the wrappers as described below.}}

====Local====

Local variables can be used throughout the same script file.

<syntaxhighlight lang="cpp">
void SetLocalVarInt(string& asName, int alVal);
void AddLocalVarInt(string& asName, int alVal);
int GetLocalVarInt(string& asName);
</syntaxhighlight>

<syntaxhighlight lang="c++">
void SetLocalVarFloat(string& asName, float afVal);
void AddLocalVarFloat(string& asName, float afVal);
float GetLocalVarFloat(string& asName);
</syntaxhighlight>

<syntaxhighlight lang="c++">
void SetLocalVarString(string& asName, const string& asVal);
void AddLocalVarString(string& asName, string& asVal);
string& GetLocalVarString(string& asName);
</syntaxhighlight>

====Global====

Global variables can be used throughout several maps and can be accessed by several script files.

<syntaxhighlight lang="c++">
void SetGlobalVarInt(string& asName, int alVal);
void AddGlobalVarInt(string& asName, int alVal);
int GetGlobalVarInt(string& asName);
</syntaxhighlight>

<syntaxhighlight lang="c++">
void SetGlobalVarFloat(string& asName, float afVal);
void AddGlobalVarFloat(string& asName, float afVal);
float GetGlobalVarFloat(string& asName);
</syntaxhighlight>

<syntaxhighlight lang="c++">
void SetGlobalVarString(string& asName, const string& asVal);
void AddGlobalVarString(string& asName, string& asVal);
string& GetGlobalVarString(string& asName);
</syntaxhighlight>

===Particle Systems===

<syntaxhighlight lang="c++">
void PreloadParticleSystem(string& asPSFile);
</syntaxhighlight>

Preloads a particle system.

#''asPSFile'' - The particle system file to load. Extension: .ps
<syntaxhighlight lang="c++">
void CreateParticleSystemAtEntity(string& asPSName, string& asPSFile, string& asEntity, bool abSavePS);
</syntaxhighlight>

Creates a particle system on an entity.

#''asPSName ''- internal name
#''asPSFile ''- the particle system to use + extension .ps
#''asEntity ''- the entity to create the particle system at
#''abSavePS ''- determines whether a particle system should "remember" its shown/hidden state, so that this state can be restored when the player revisits the level
<syntaxhighlight lang="c++">
void CreateParticleSystemAtEntityExt(string& asPSName, string& asPSFile, string& asEntity, bool abSavePS,
float afR, float afG, float afB, float afA, bool abFadeAtDistance, float afFadeMinEnd, float afFadeMinStart,
float afFadeMaxStart, float afFadeMaxEnd);
</syntaxhighlight>

Creates a particle system on an entity, extended method with more options.

#''asPSName ''- internal name
#''asPSFile ''- the particle system to use + extension .ps
#''asEntity ''- the entity to create the particle system at
#''abSavePS ''- determines whether a particle system should "remember" its shown/hidden state, so that this state can be restored when the player revisits the level
#''afR ''- red value
#''afG ''- green value
#''afB ''- blue value
#''afA ''- alpha value
#''abFadeAtDistance ''- determines whether a particle system fades from a certain distance on
#''afFadeMinEnd ''- minimum distance at which the particle system stops fading
#''afFadeMinStart ''- minimum distance at which the particle system starts fading
#''afFadeMaxStart ''- maximum distance at which the particle system starts fading
#''afFadeMaxEnd ''- maximum distance at which the particle system stops fading
<syntaxhighlight lang="c++">
void DestroyParticleSystem(string& asName);
</syntaxhighlight>

Destroys a particle system.

#''asName'' - The internal name of the particle system

===Sounds & Music===

<syntaxhighlight lang="c++">
void PreloadSound(string& asSoundFile);
</syntaxhighlight>

Preloads a sound.

#''asSoundFile'' - The sound file to load. Extension: .snt
<syntaxhighlight lang="c++">
void PlaySoundAtEntity(string& asSoundName, string& asSoundFile, string& asEntity, float afFadeTime, bool abSaveSound);
</syntaxhighlight>

Creates a sound on an entity.

#''asSoundName ''- internal name
#''asSoundFile ''- the sound to use + extension .snt
#''asEntity ''- the entity to create the sound at, can be "Player"
#''afFadeTime ''- time in seconds the sound needs to fade. Avoids enemies hearing the sound if afFadeTime is at least 0.1f
#''abSaveSound ''- if ''true'', a looping sound will "remember" its playback state (currently playing/stopped), and that state will be restored the next time the level is entered. If ''true'', the sound is never attached to the entity! Note that saving should only be used on ''looping sounds''!
<syntaxhighlight lang="c++">
void FadeInSound(string& asSoundName, float afFadeTime, bool abPlayStart);
</syntaxhighlight>

Fades in a sound.

#''asSoundName ''- internal name
#''afFadeTime ''- time in seconds
#''abPlayStart ''- ?
<syntaxhighlight lang="c++">
void StopSound(string& asSoundName, float afFadeTime);
</syntaxhighlight>

Fades out a sound.

#''asSoundName ''- internal name
#''afFadeTime ''- time in seconds, use 0 to immediatly stop the sound
<syntaxhighlight lang="c++">
void PlayMusic(string& asMusicFile, bool abLoop, float afVolume, float afFadeTime, int alPrio, bool abResume);
</syntaxhighlight>

Plays music.

#''asMusicFile ''- the music to play + extension .ogg
#''abLoop ''- determines whether a music track should loop
#''afVolume ''- volume of the music
#''afFadeTime ''- time in seconds until music reaches full volume
#''alPrio ''- priority of the music. Note that only the music with the highest priority can be heard! 0 - lowest, 1 - higher, etc.
#''abResume'' - if ''true'', playback will be continued from where the track stopped after the call to StopMusic(); if ''false'', the track will be restarted.
<syntaxhighlight lang="c++">
void StopMusic(float afFadeTime, int alPrio);
</syntaxhighlight>

Stops music.

#''afFadeTime ''- time in seconds until music stops
#''alPrio ''- the priority of the music that should stop
<syntaxhighlight lang="c++">
void FadeGlobalSoundVolume(float afDestVolume, float afTime);
</syntaxhighlight>

Influences the global sound volume, that means everything you can hear '''from the world'''. This does not affect music of GUI sounds.

#''afDestVolume ''- desired volume
#''afTime ''- time in seconds until volume reaches desired volume
<syntaxhighlight lang="c++">
void FadeGlobalSoundSpeed(float afDestSpeed, float afTime);
</syntaxhighlight>

Influences the global sound speed.

#''afDestSpeed ''- desired speed
#''afTime ''- time in seconds until volume reaches desired speed

===Lights===

<syntaxhighlight lang="c++">
void SetLightVisible(string& asLightName, bool abVisible);
</syntaxhighlight>

Enables/disables lights.

#''asLightName ''- internal name
#''abVisible ''- determines the state of the light
<syntaxhighlight lang="c++">
void FadeLightTo(string& asLightName, float afR, float afG, float afB, float afA, float afRadius, float afTime);
</syntaxhighlight>

Changes the properties of a light.

#''asLightName ''- internal name
#''afR ''- red value
#''afG ''- green value
#''afB ''- blue value
#''afA ''- alpha value
#''afRadius ''- radius of the light. -1 means keeping the radius
#''afTime ''- time in seconds until change is done
<syntaxhighlight lang="c++">
void SetLightFlickerActive(string& asLightName, bool abActive);
</syntaxhighlight>

Activates flickering on a light.

#''asLightName'' - The internal light name
#''abActive'' - true = active, false = inactive

==Game scripts==

===General===

<syntaxhighlight lang="c++">
void StartCredits(string& asMusic, bool abLoopMusic, string& asTextCat, string& asTextEntry, int alEndNum);
</syntaxhighlight>

Starts the end credits screen.

#''asMusic ''- the music to play (including .ogg)
#''abLoopMusic ''- determines whether the music should loop
#''asTextCat ''- the category to be used in the .lang file
#''asTextEntry ''- the entry in the .lang file
#''alEndNum ''- Amnesia has 3 different endings and displays a code at the bottom. Determines which code is displayed. 0-2 will display codes, any other integer will not.
<syntaxhighlight lang="c++">
void StartDemoEnd();
</syntaxhighlight>

Starts the end images that are used in the demo, images are named "demo_end01.jpg", increase the number for each image you want to use. (NEEDS VERIFICATION)

<syntaxhighlight lang="c++">
void AutoSave();
</syntaxhighlight>

Save the game to the auto save.

<syntaxhighlight lang="c++">
void CheckPoint (string& asName, string& asStartPos, string& asCallback, string& asDeathHintCat, string& asDeathHintEntry);
</syntaxhighlight>

Sets a checkpoint at which the player will respawn in case he dies. Callback syntax: <code>void MyFunc(string &in asName, int alCount)</code> Count is 0 on the first checkpoint load!

#''asName ''- the internal name
#''asStartPos ''- the name of the StartPos in the editor
#''asCallback ''- the function to call when the player dies/respawns
#''asDeathHintCat ''- the category of the death hint message to be used in the .lang file
#''asDeathHintEntry ''- the entry in the .lang file
<syntaxhighlight lang="c++">
void ChangeMap(string& asMapName, string& asStartPos, string& asStartSound, string& asEndSound);
</syntaxhighlight>

Immediatly loads another map.

#''asMapName ''- the file to load
#''asStartPos ''- the name of the StartPos on the next map
#''asStartSound ''- the sound that is played when the change starts
#''asEndSound ''- the sound that is played when the new map is loaded
<syntaxhighlight lang="c++">
void ClearSavedMaps();
</syntaxhighlight>

Clears the "history" of the save, useful to do when you know the player will not be able to go back anymore. Makes the next save much smaller in size.

<syntaxhighlight lang="c++">
void CreateDataCache();
void DestroyDataCache();
</syntaxhighlight>

This caches all current textures and models and they are not released until destroy is called. If there is already cached data it is destroyed.
Create caches to enable faster loading when going back to a map. Destroy the cache if you know the player won't go back to that map.

<syntaxhighlight lang="c++">
void SetMapDisplayNameEntry(string& asNameEntry);
</syntaxhighlight>

Sets the map name shown in save file names. If none is set NULL is assumed.

#''asNameEntry ''- the entry to display, category must be "Levels"!
<syntaxhighlight lang="c++">
void SetSkyBoxActive(bool abActive);
</syntaxhighlight>

Enables/Disables the skybox.

#''abActive'' - true = active, false = inactive
<syntaxhighlight lang="c++">
void SetSkyBoxTexture(string& asTexture);
</syntaxhighlight>

Sets the texture of the skybox.

#''asTexture'' - The texture file to set. Extension: .dds
<syntaxhighlight lang="c++">
void SetSkyBoxColor(float afR, float afG, float afB, float afA);
</syntaxhighlight>

Sets the solid color of the skybox rather than a texture.

#''afR ''- red value
#''afG ''- green value
#''afB ''- blue value
#''afA ''- alpha value
<syntaxhighlight lang="c++">
void SetFogActive(bool abActive);
</syntaxhighlight>

Enables/Disables the global fog.

#''abActive'' - true = active, false = inactive
<syntaxhighlight lang="c++">
void SetFogColor(float afR, float afG, float afB, float afA);
</syntaxhighlight>

Sets the color to use for the global fog.

#''afR ''- red value
#''afG ''- green value
#''afB ''- blue value
#''afA ''- alpha value
<syntaxhighlight lang="c++">
void SetFogProperties(float afStart, float afEnd, float afFalloffExp, bool abCulling);
</syntaxhighlight>

Sets the properties for the global fog.

#''afStart ''- how many meters from the camera should the fog begin
#''afEnd ''- how many meters from the camera should the fog reach full thickness
#''afFalloffExp ''- the amount by which the thinkness increases
#''abCulling ''- whether occlusion culling is active for the fog; this prevents objects behind the fog from being loaded
<syntaxhighlight lang="c++">
void SetupLoadScreen(string&asTextCat, string&asTextEntry, int alRandomNum, string&asImageFile);
</syntaxhighlight>

Determines which loading screen will be shown when changing maps.

#''asTextCat ''- the category of the loading text in the .lang file to be shown on the loading screen
#''asTextEntry ''- the entry in the .lang file
#''alRandomNum ''- if greater 1, then it will randomize between 1 and alRandom for each LoadScreen giving entry the suffix XX (eg 01). If < =1 then no suffix is added
#''asImageFile ''- the image to be shown (optional)

===Game Timer===

<syntaxhighlight lang="c++">
void AddTimer(string& asName, float afTime, string& asFunction);
</syntaxhighlight>

Creates a timer which calls a function when it expires. Callback syntax: <code>void MyFunc(string &in asTimer)</code>

#''asName ''- the name of the timer
#''afTime ''- time in seconds
#''asFunction ''- the function to call
<syntaxhighlight lang="c++">
void RemoveTimer(string& asName);
</syntaxhighlight>

Removes a timer, no matter how much time is left.

#''asName'' - the internal name of the timer.
<syntaxhighlight lang="c++">
float GetTimerTimeLeft(string& asName);
</syntaxhighlight>

Returns the time left on a timer.

#''asName'' - the internal name of the timer.

===Screen Effects===

<syntaxhighlight lang="c++">
void FadeOut(float afTime);
</syntaxhighlight>

Fades the screen to black.

''afTime ''- time in seconds until the screen is completly black

<syntaxhighlight lang="c++">
void FadeIn(float afTime);
</syntaxhighlight>

Fades the screen back to normal.

''afTime ''- time in seconds until the screen back to normal

<syntaxhighlight lang="c++">
void FadeImageTrailTo(float afAmount, float afSpeed);
</syntaxhighlight>

Applies the image trail effect to the screen.

''afAmount ''- intensity (default: 0) ''afSpeed ''- time in seconds until full effect

<syntaxhighlight lang="c++">
void FadeSepiaColorTo(float afAmount, float afSpeed);
</syntaxhighlight>

Makes the screen go dark red.

''afAmount ''- intensity (default: 0) ''afSpeed ''- time in seconds until full effect

<syntaxhighlight lang="c++">
void FadeRadialBlurTo(float afSize, float afSpeed);
</syntaxhighlight>

Applies radial blur effects to the screen.

''afSize ''- intensity (default: 0) ''afSpeed ''- time in seconds until full effect

<syntaxhighlight lang="c++">
void SetRadialBlurStartDist(float afStartDist);
</syntaxhighlight>

Determines at which distance the radial blur effects appear.

''afStartDist ''- the distance at which the effect starts

<syntaxhighlight lang="c++">
void StartEffectFlash(float afFadeIn, float afWhite, float afFadeOut);
</syntaxhighlight>

Fades the screen to white.

''afFadeIn ''- time in seconds until screen is white ''afWhite ''- determines to which percentage the screen fades to white (1.0 = completly white) ''afFadeOut ''- time in seconds until screen is back to normal again

<syntaxhighlight lang="c++">
void StartEffectEmotionFlash(string& asTextCat, string& asTextEntry, string& asSound);
</syntaxhighlight>

Fades the screen to white and shows a text message.

''asTextCat ''- the category in the .lang file ''asTextEntry ''- the text entry in the .lang file ''asSound ''- the sound to play while fading

<syntaxhighlight lang="c++">
void AddEffectVoice(string& asVoiceFile, string& asEffectFile, string& asTextCat, string& asTextEntry,
bool abUsePosition, string& asPosEntity, float afMinDistance, float afMaxDistance);
</syntaxhighlight>

This adds a voice and an effect to be played. It is okay to call this many times in order to play many voices in a row. The EffectVoiceOverCallback is not called until ALL voices have finished.

''asVoiceFile ''- the voice to play ''asEffectFile ''- the effect to play ''asTextCat ''- the category in the .lang file ''asTextEntry ''- the text entry in the .lang file ''abUsePosition ''- plays using 3D from the entity, or without 3D ''asPosEntity ''- the entity at which the effect appears ''afMinDistance ''- minimum distance to see the effect ''afMaxDistance ''- maximum distance to see the effect

<syntaxhighlight lang="c++">
void StopAllEffectVoices(float afFadeOutTime);
</syntaxhighlight>

Stops all voices and calls the EffectVoiceOverCallback.

<syntaxhighlight lang="c++">
bool GetEffectVoiceActive();
</syntaxhighlight>

Checks whether EffectVoices are still active.

<syntaxhighlight lang="c++">
void SetEffectVoiceOverCallback(string& asFunc);
</syntaxhighlight>

Sets the function to be called when the EffectVoices are finished. Callback syntax: <code>void MyFunc()</code>

<syntaxhighlight lang="c++">
bool GetFlashbackIsActive();
</syntaxhighlight>

Checks whether a flashback is still in effect.

<syntaxhighlight lang="c++">
void StartPlayerSpawnPS(string& asSPSFile);
void StopPlayerSpawnPS();
</syntaxhighlight>

Continuously spawn regular particle systems (''.ps'') around the player. Particles created by this script carry over from map to map. ''asSPSFile'' - the ''.sps'' file to use. Exemplary ''.sps'' files are located in the ''/misc'' folder in the main game directory. Custom ''.sps'' files can be created by hand in a text editor (see existing ones and mimic how those are written). Since ''StopPlayerSpawnPS()'' doesn't seem to work, to stop an SPS you must create an ''.sps'' file with an empty particle field field and override the old SPS by calling ''StartPlayerSpawnPS'' again.

<syntaxhighlight lang="c++">
void PlayGuiSound(string& asSoundFile, float afVolume);
</syntaxhighlight>

Plays a sound, not using 3D.

''asSoundFile ''- the sound to play (extension is .snt) ''afVolume ''- the volume of the sound

<syntaxhighlight lang="c++">
void StartScreenShake(float afAmount, float afTime, float afFadeInTime, float afFadeOutTime);
</syntaxhighlight>

Shakes the screen.

''afAmount ''- intensity of the shake ''afTime ''- duration of the shake ''afFadeInTime ''- time in seconds until full intensity is reached ''afFadeOutTime ''- time until screen is back to normal

<syntaxhighlight lang="c++">
void SetInDarknessEffectsActive(bool abX);
</syntaxhighlight>

{{ReqVer|1.3}}

Enables/disables the sanity drain and night vision effects while in the darkness.

''bool abX'' - Enable/disable effects.

===Insanity===

<syntaxhighlight lang="c++">
void SetInsanitySetEnabled(string& asSet, bool abX);
</syntaxhighlight>

Determines which InsanitySets are enabled.

''asSet ''- the set ''abX ''- enabled or not

<syntaxhighlight lang="c++">
void StartInsanityEvent(string &in asEventName);
</syntaxhighlight>

{{ReqVer|1.3}}

Starts a specified insanity event.

''asEventName ''- Insanity event to play.

<syntaxhighlight lang="c++">
void StartRandomInsanityEvent();
</syntaxhighlight>

Starts a random insanity event from the available sets.

<syntaxhighlight lang="c++">
void StopCurrentInsanityEvent();
</syntaxhighlight>

{{ReqVer|1.3}}

Stops the currently playing insanity event.

<syntaxhighlight lang="c++">
void InsanityEventIsActive();
</syntaxhighlight>

Checks whether an insanity event is currently in effect… Or so it was supposed to be, but as it doesn't return a value, we can never know [http://wiki.frictionalgames.com/lib/images/smileys/icon_smile.gif?nolink&15x15]

===Player===

Note that the player's maximum health and sanity is 100.

<syntaxhighlight lang="c++">
void SetPlayerActive(bool abActive);
</syntaxhighlight>

Enabled/Disable player controlled movement.

<syntaxhighlight lang="c++">
void ChangePlayerStateToNormal();
</syntaxhighlight>

Sets certain effects back to normal. It can for example make the player drop an item.

<syntaxhighlight lang="c++">
void SetPlayerCrouching(bool abCrouch);
</syntaxhighlight>

Forces the player to crouch.

<syntaxhighlight lang="c++">
void AddPlayerBodyForce(float afX, float afY, float afZ, bool abUseLocalCoords);
</syntaxhighlight>

Pushes the player into a certain direction. Note that you need values above ~2000 to see any effects.

''afX ''- amount along the X-axis ''afY ''- amount along the Y-axis ''afZ ''- amount along the Z-axis ''abUseLocalCoords ''- If true, axes are based on where the player is facing, not the world.

<syntaxhighlight lang="c++">
void ShowPlayerCrossHairIcons(bool abX);
</syntaxhighlight>

Enables/Disables the icons when a player has something in focus.

<syntaxhighlight lang="c++">
void SetPlayerSanity(float afSanity);
void AddPlayerSanity(float afSanity);
float GetPlayerSanity();
</syntaxhighlight>

Modifies/returns the sanity of the player.

<syntaxhighlight lang="c++">
void SetPlayerHealth(float afHealth);
void AddPlayerHealth(float afHealth);
float GetPlayerHealth();
</syntaxhighlight>

Modifies/returns the health of the player.

<syntaxhighlight lang="c++">
void SetPlayerLampOil(float afOil);
void AddPlayerLampOil(float afOil);
float GetPlayerLampOil();
</syntaxhighlight>

Modifies/returns the lamp oil of the player.

<syntaxhighlight lang="c++">
float GetPlayerSpeed();
float GetPlayerYSpeed();
</syntaxhighlight>

Returns the current speed of the player.

<syntaxhighlight lang="c++">
void SetSanityDrainDisabled(bool abX);
</syntaxhighlight>

Enables/Disables sanity drain from darkness, monsters, etc.

<syntaxhighlight lang="c++">
void GiveSanityBoost();
void GiveSanityBoostSmall();
</syntaxhighlight>

Boosts the player's sanity by a fixed amount.

<syntaxhighlight lang="c++">
void GiveSanityDamage(float afAmount, bool abUseEffect);
</syntaxhighlight>

Reduces the sanity of the player.

''afAmount ''- amount of sanity damage done ''abUseEffect ''- determines whether an effect is played when the sanity damage is dealt

<syntaxhighlight lang="c++">
void GivePlayerDamage(float afAmount, string& asType, bool abSpinHead, bool abLethal);
</syntaxhighlight>

Reduces the health of the player.

''afAmount ''- amount of damage done to health ''asType ''- plays a certain effect on the screen when the damage is dealt (BloodSplat, Claws or Slash) ''abSpinHead ''- changes the camera view when damage is dealt ''abLethal ''- set to true if player can die from given damage

<syntaxhighlight lang="c++">
void FadePlayerFOVMulTo(float afX, float afSpeed);
</syntaxhighlight>

Changes the field of view of the player. A shorter FOV will create a zoom effect.

''afX ''- multiplier of default FOV (1 is default) ''afSpeed ''- the speed of change between FOV's

<syntaxhighlight lang="c++">
void FadePlayerAspectMulTo(float afX, float afSpeed);
</syntaxhighlight>

Changes the aspect ratio of the player. Basically stretches or narrows the screen horizontally.

''afX ''- multiplier of default aspect (default is 1) ''afSpeed ''- the speed of change between FOV's

<syntaxhighlight lang="c++">
void FadePlayerRollTo(float afX, float afSpeedMul, float afMaxSpeed);
</syntaxhighlight>

Rotates the position of the camera on the player's body.

''afX ''- angle of rotation of head, positive being counter-clockwise ''afSpeedMul ''- speed (possibly acceleration) multiplier of the rotation (default 1, which is really slow) ''afMaxSpeed ''- maximum speed of rotation

<syntaxhighlight lang="c++">
void MovePlayerHeadPos(float afX, float afY, float afZ, float afSpeed, float afSlowDownDist);
</syntaxhighlight>

Changes the position of the camera on the player's body.

''afX ''- amount along the X-axis ''afY ''- amount along the Y-axis ''afZ ''- amount along the Z-axis ''afSpeed ''- speed at which the change happens ''afSlowDownDist ''- distance at which to start slowing down (prevents the head from abruptly stopping)

<syntaxhighlight lang="c++">
void StartPlayerLookAt(string& asEntityName, float afSpeedMul, float afMaxSpeed, string& asAtTargetCallback);
void StopPlayerLookAt();
</syntaxhighlight>

Forces the player to look at a certain entity until StopPlayerLookAt is used.

''asEntityName ''- the entity to look at ''afSpeedMul ''- how fast should the player look at the entity ''afMaxSpeed ''- maximum speed allowed ''asAtTargetCallback ''- function to call when player looks at target

<syntaxhighlight lang="c++">
void SetPlayerMoveSpeedMul(float afMul);
void SetPlayerRunSpeedMul(float afMul);
void SetPlayerLookSpeedMul(float afMul);
</syntaxhighlight>

Changes the player's move/run/look speed. Default is 1.

<syntaxhighlight lang="c++">
void SetPlayerJumpForceMul(float afMul);
</syntaxhighlight>

{{ReqVer|1.3}}

Changes the player's jump multiplier. Higher values = higher jumps. Default is 1.

<syntaxhighlight lang="c++">
void SetPlayerJumpDisabled(bool abX);
void SetPlayerCrouchDisabled(bool abX);
</syntaxhighlight>

Enables/Disables the player's ability to jump/crouch.

<syntaxhighlight lang="c++">
void TeleportPlayer(string& asStartPosName);
</syntaxhighlight>

Instantly teleports the player to the target StartPos.

<syntaxhighlight lang="c++">
void SetLanternActive(bool abX, bool abUseEffects);
</syntaxhighlight>

Makes the player use his lantern.

<syntaxhighlight lang="c++">
bool GetLanternActive();
</syntaxhighlight>

Checks whether the player currently uses his lantern.

<syntaxhighlight lang="c++">
void SetLanternDisabled(bool abX);
</syntaxhighlight>

Enables/Disables the player's ability to use his lantern.

<syntaxhighlight lang="c++">
void SetLanternLitCallback(string& asCallback);
</syntaxhighlight>

Sets the function to call when the player uses his lantern. Callback syntax: <code>MyFunc(bool abLit)</code>

<syntaxhighlight lang="c++">
void SetMessage(string& asTextCategory, string& asTextEntry, float afTime);
</syntaxhighlight>

Displays a message on the screen.

''asTextCategory ''- the category in the .lang file ''asTextEntry ''- the entry in the .lang file ''afTime ''- determines how long the message is displayed. If time is < =0 then the life time is calculated based on string length.

<syntaxhighlight lang="c++">
void SetDeathHint(string& asTextCategory, string& asTextEntry);
</syntaxhighlight>

Sets the message that appears when the player dies.

''asTextCategory ''- the category in the .lang file ''asTextEntry ''- the entry in the .lang file

<syntaxhighlight lang="c++">
void DisableDeathStartSound();
</syntaxhighlight>

Disables the death sound when the player dies. This must be called directly before player is killed! The variable as soon as player dies too.

<syntaxhighlight lang="">
void MovePlayerForward(float afAmount)
</syntaxhighlight>

"REQUIRES THE 1.2 PATCH: JUSTINE" Moves the player forward. It needs to be called in a timer that updates 60 times / second.

<syntaxhighlight lang="c++">
void SetPlayerFallDamageDisabled(bool abX);
</syntaxhighlight>

{{ReqVer|1.3}}

Enables/disables the player's ability to take fall damage.

<syntaxhighlight lang="c++">
void SetPlayerPos(float afX, float afY, float afZ);
</syntaxhighlight>

{{ReqVer|1.3}}

Sets the player's position within the level.

''afX'' - X co-ordinate position. ''afY'' - Y co-ordinate position. ''afZ'' - Z co-ordinate position.

<syntaxhighlight lang="c++">
float GetPlayerPosX();
float GetPlayerPosY();
float GetPlayerPosZ();
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the player's position within the level on the specified axis.

===Journal===

<syntaxhighlight lang="c++">
void AddNote(string& asNameAndTextEntry, string& asImage);
</syntaxhighlight>

Adds a note to the player's journal.

''asNameAndTextEntry ''- entries in the .lang file. Must end with _Name and _Text and be in category "Journal"! ''asImage ''- the background image to be used

<syntaxhighlight lang="c++">
void AddDiary(string& asNameAndTextEntry, string& asImage);
</syntaxhighlight>

Adds a diary to the player's journal.

''asNameAndTextEntry ''- entries in the .lang file. Must end with _NameX and _TextY whereas X and Y are numbers of the parts (_Name1: first diary, _Text1: first page) and be in category "Journal"! ''asImage ''- the background image to be used

<syntaxhighlight lang="c++">
void ReturnOpenJournal(bool abOpenJournal);
</syntaxhighlight>

Only called in the pickup diary callback! If true the journal displays the entry else not.

===Quests===

<syntaxhighlight lang="c++">
void AddQuest(string& asName, string& asNameAndTextEntry);
</syntaxhighlight>

Adds a quest to the player's journal under mementos.

''asName ''- the internal name to be used ''asNameAndTextEntry ''- entry in the .lang file. Must start with "Quest_<texthere>_Text”, and be in category “Journal”!

<syntaxhighlight lang="c++">
void CompleteQuest(string& asName, string& asNameAndTextEntry);
</syntaxhighlight>

Completes a quest.

''asName ''- the internal name of the quest ''asNameAndTextEntry ''- entry in the .lang file. Must start with " Quest_<texthere>_Text ”, and be in category “Journal”!

<syntaxhighlight lang="c++">
bool QuestIsCompleted(string& asName);
bool QuestIsAdded(string& asName);
</syntaxhighlight>

Checks whether a quest is completed/added.

<syntaxhighlight lang="c++">
void SetNumberOfQuestsInMap(int alNumberOfQuests);
</syntaxhighlight>

Sets the number of quests in the map.

''alNumberOfQuests ''- Amount of Quests

<syntaxhighlight lang="c++">
void GiveHint (string& asName, string& asMessageCat, string& asMessageEntry, float afTimeShown);
</syntaxhighlight>

Displays a hint on the player's screen.

''asName ''- the internal name ''asMessageCat ''- the category in the .lang file ''asMessageEntry ''- the entry in the .lang file ''afTimeShown ''- time in seconds until the message disappears. If time is <= 0 then the life time is calculated based on string length.

<syntaxhighlight lang="c++">
void RemoveHint (string& asName);
void BlockHint (string& asName);
void UnBlockHint (string& asName);
</syntaxhighlight>

Removes<nowiki>\</nowiki>Blocks<nowiki>\</nowiki>Unblocks a hint.

===Inventory===

<syntaxhighlight lang="c++">
void ExitInventory();
</syntaxhighlight>

Exits the inventory by force.

<syntaxhighlight lang="c++">
void SetInventoryDisabled(bool abX);
</syntaxhighlight>

Disables the player's ability to open his inventory.

<syntaxhighlight lang="c++">
void SetInventoryMessage(string& asTextCategory, string& asTextEntry, float afTime);
</syntaxhighlight>

Adds a message at the bottom of the inventory screen.

''asTextCategory ''- the category in the .lang file ''asTextEntry ''- the entry in the .lang file ''afTime ''- time in seconds until the message disappears. If life time is <= 0 then the life time is calculated based on string length.

<syntaxhighlight lang="c++">
void GiveItem(string& asName, string& asType, string& asSubTypeName, string& asImageName, float afAmount);
</syntaxhighlight>

Adds an item to the inventory of the player. Note that the item does not have to exist as entity in the world to be able to do this.

''asName ''- internal name ''asType ''- item type to give, Available types are: 

*Puzzle
*Lantern
*Health
*Sanity
*LampOil
*Tinderbox

''asSubTypeName ''- item name for .lang file ''asImageName ''- the image which will appear in inventory. For example: <code>void GiveItem("chemical_container_full_1", "Puzzle", "chemical_container_full", "chemical_container_full.tga", 1);</code> will use the image from <code>graphics/item/chemical_container_full.tga</code>

''afAmount ''- amount the item gives, - For example: Oil potions will fill the oil meter by this amount, Health potions will heal by this amount, etc.

<syntaxhighlight lang="c++">
void RemoveItem(string& asName);
</syntaxhighlight>

Removes an item from the player's inventory.

<syntaxhighlight lang="c++">
bool HasItem(string& asName);
</syntaxhighlight>

Checks whether the player has an item in his inventory.

<syntaxhighlight lang="c++">
void GiveItemFromFile(string& asName, string& asFileName);
</syntaxhighlight>

Adds a single item to the player's inventory. This is meant to be used for debug mostly as it creates the actual item and then destroys it.

''asName ''- internal name ''asFileName ''- item to give + extension (.ent)

<syntaxhighlight lang="c++">
void AddCombineCallback(string& asName, string& asItemA, string& asItemB, string& asFunction, bool abAutoRemove);
</syntaxhighlight>

Allows the player to combine items in his inventory. Callback syntax: <code>void MyFunc(string &in asItemA, string &in asItemB)</code>

''asName ''- internal name for the callback ''asItemA ''- internal name of first item ''asItemB ''- internal name of second item ''asFunction ''- the function to call ''abAutoRemove ''- determines whether the callback should be removed when the items are combined

<syntaxhighlight lang="c++">
void RemoveCombineCallback(string& asName);
</syntaxhighlight>

Removes a combine callback. ''asName'' - the internal name of the callback to be removed (as specified in AddCombineCallback)

<syntaxhighlight lang="c++">
void AddUseItemCallback(string& asName, string& asItem, string& asEntity, string& asFunction, bool abAutoDestroy);
</syntaxhighlight>

Allows the player to use items on the world. Callback syntax: <code>void MyFunc(string &in asItem, string &in asEntity)</code>

''asName ''- internal name ''asItem ''- internal name of the item ''asEntity ''- entity to be able to use the item on ''asFunction ''- function to call ''abAutoDestroy ''- determines whether the item is destroyed when used

<syntaxhighlight lang="c++">
void RemoveUseItemCallback(string& asName);
</syntaxhighlight>

Removes an item callback.

===Entities===

====General====

<syntaxhighlight lang="c">
void SetEntityActive(string& asName, bool abActive);
</syntaxhighlight>

Activates/deactivates an entity.

<syntaxhighlight lang="c">
void SetEntityVisible(string &in asName, bool abVisible);
</syntaxhighlight>

{{ReqVer|1.3}}

Activates/deactivates an entity's visual mesh. The collision body remains.

''asName'' - Name of the entity. ''abActive'' - Activate/deactivate mesh.

<syntaxhighlight lang="c">
bool GetEntityExists(string& asName);
</syntaxhighlight>

Checks whether an entity exists.

<syntaxhighlight lang="c">
void SetEntityCustomFocusCrossHair(string& asName, string& asCrossHair);
</syntaxhighlight>

Changes the crosshair that is used when focusing an entity.

''asName ''- internal name ''asCrossHair ''- desired crosshair, can be: Default (uses default), Grab, Push, Ignite, Pick, LevelDoor, Ladder

<syntaxhighlight lang="c">
void CreateEntityAtArea(string& asEntityName, string& asEntityFile, string& asAreaName, bool abFullGameSave);
</syntaxhighlight>

Creates an entity at an area. When creating an enemy though, it cannot chase properly along PathNodes(using for example ShowEnemyPlayerPosition).

''asEntityName ''- internal name ''asEntityFile ''- entity to be used extension .ent ''asAreaName ''- the area to create the entity at ''abFullGameSave ''- determines whether an entity "remembers" its state

<syntaxhighlight lang="c">
void ReplaceEntity(string &in asName, string &in asBodyName, string &in asNewEntityName, string &in asNewEntityFile, bool abFullGameSave);
</syntaxhighlight>

{{ReqVer|1.3}}

Removes an entity and places a new one in its place.

''asName'' - Name of the entity to replace. ''asBodyName'' - Name of the body of the entity to place the new entity at. If empty the first body is used (might be buggy, recommended to name a body anyway). ''asNewEntityName'' - Name of the new entity. ''asNewEntityFile'' - Name of the new entity file. Extension .ent. ''abFullGameSave'' - Whether ALL properties of this entity should be saved throughout levels.

<syntaxhighlight lang="c++">
void PlaceEntityAtEntity(string &in asName, string &in asTargetEntity, string &in asTargetBodyName, bool abUseRotation);
</syntaxhighlight>

{{ReqVer|1.3}}

Places an entity at the position of another entity. Does not work for enemies, use TeleportEnemyToEntity instead.

''asName'' - Name of the entity to place. ''asTargetEntity'' - Name of the other entity to place the first entity at. ''asTargetBodyName'' - Name of the body of the entity to place the first entity at. If empty the first body is used (might be buggy, recommended to name a body anyway). ''abUseRotation'' - Whether the entity should be rotated like the target entity.

<syntaxhighlight lang="c">
void SetEntityPos(string &in asName, float afX, float afY, float afZ);
</syntaxhighlight>

{{ReqVer|1.3}}

Moves an entity to a position in the level.

''asName'' - Name of the entity to move. ''afX'' - X co-ordinate position. ''afY'' - Y co-ordinate position. ''afZ'' - Z co-ordinate position.

<syntaxhighlight lang="c">
float GetEntityPosX(string &in asName);
float GetEntityPosY(string &in asName);
float GetEntityPosZ(string &in asName);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns an entity's position in the level on the specified axis.

''asName'' - Name of the entity.

<syntaxhighlight lang="c">
void SetEntityPlayerLookAtCallback(string& asName, string& asCallback, bool abRemoveWhenLookedAt);
</syntaxhighlight>

Calls a function when the player looks at a certain entity. Callback syntax: <code>void MyFunc(string &in asEntity, int alState)</code> alState: 1 = looking, -1 = not looking

''asName ''- internal name ''asCallback ''- function to call ''abRemoveWhenLookedAt ''- determines whether the callback should be removed when the player looked at the entity

<syntaxhighlight lang="c">
void SetEntityPlayerInteractCallback(string& asName, string& asCallback, bool abRemoveOnInteraction);
</syntaxhighlight>

Calls a function when the player interacts with a certain entity. Callback syntax: <code>void MyFunc(string &in asEntity)</code>

''asName ''- internal name ''asCallback ''- function to call ''abRemoveOnInteraction ''- determines whether the callback should be removed when the player interacts with the entity

<syntaxhighlight lang="c">
void SetEntityCallbackFunc(string& asName, string& asCallback);
</syntaxhighlight>

Calls a function when the player interacts with a certain entity. Callback syntax: <code>void MyFunc(string &in asEntity, string &in type)</code> Type depends on entity type and includes: "OnPickup", "Break", "OnIgnite", etc

<syntaxhighlight lang="c">
void SetEntityConnectionStateChangeCallback(string& asName, string& asCallback);
</syntaxhighlight>

A callback called when ever the connection state changes (button being switched on, lever switched, etc). Callback syntax: <code>void Func(string &in asEntity, int alState)</code> alState: -1 = off, 0 = between, 1 = on

<syntaxhighlight lang="c">
void SetEntityInteractionDisabled(string& asName, bool abDisabled);
</syntaxhighlight>

Disallows interaction with an entity.

<syntaxhighlight lang="c">
void BreakJoint (string& asName);
</syntaxhighlight>

Breaks a joint. Do not use this on joints in SwingDoors, Levers, Wheels, etc. where the joint is part of an interaction. That will make the game crash.

<syntaxhighlight lang="c">
void AddEntityCollideCallback(string& asParentName, string& asChildName, string& asFunction, bool abDeleteOnCollide, int alStates);
</syntaxhighlight>

Calls a function when two entites collide. Callback syntax: <code>void MyFunc(string &in asParent, string &in asChild, int alState)</code> alState: 1 = enter, -1 = leave

''asParentName ''- internal name of main object ''asChildName ''- internal name of object that collides with main object (asterix (<nowiki>*</nowiki>) NOT supported!) ''asFunction ''- function to call ''abDeleteOnCollide ''- determines whether the callback after it was called ''alStates ''- 1 = only enter, -1 = only leave, 0 = both

<syntaxhighlight lang="c">
void RemoveEntityCollideCallback(string& asParentName, string& asChildName);
</syntaxhighlight>

Removes an EntityCollideCallback. Asterix (<nowiki>*</nowiki>) not supported in ''asChildName''.

<syntaxhighlight lang="c">
bool GetEntitiesCollide(string& asEntityA, string& asEntityB);
</syntaxhighlight>

Checks whether two entites collide. This function does NOT support asterix (<nowiki>*</nowiki>) or "Player"!

<syntaxhighlight lang="c">
void SetBodyMass(string &in asName, float afMass);
</syntaxhighlight>

{{ReqVer|1.3}}

Sets the mass of an entity's body.

''asName'' - Name of the body of an entity. The body name of an entity is EntityName_BodyName. ''afMass'' - The mass to set.

<syntaxhighlight lang="c">
float GetBodyMass(string &in asName);
</syntaxhighlight>

{{ReqVer|1.3}}

Gets the mass of an entity's body.

''asName'' - Name of the body of an entity. The body name of an entity is EntityName_BodyName. ''afMass'' - The mass to get.

====Props====

<syntaxhighlight lang="c">
void SetPropEffectActive(string& asName, bool abActive, bool abFadeAndPlaySounds);
</syntaxhighlight>

Can be used on coal to give it the black color it should have.

<syntaxhighlight lang="c">
void SetPropActiveAndFade(string& asName, bool abActive, float afFadeTime);
</syntaxhighlight>

Activates/deactivates a prop.

''asName ''- internal name ''abActive ''- nothing to add ''afFadeTime ''- time in seconds until prop fully fades

<syntaxhighlight lang="c">
void SetPropStaticPhysics(string& asName, bool abX);
</syntaxhighlight>

Activates/deactivates the physics of a prop. Setting as true will make entities static in midair.

<syntaxhighlight lang="c">
bool GetPropIsInteractedWith(string& asName);
</syntaxhighlight>

Checks whether a prop is interacted with.

<syntaxhighlight lang="c">
void RotatePropToSpeed(string& asName, float afAcc, float afGoalSpeed, float afAxisX, float afAxisY, float afAxisZ, bool abResetSpeed, string& asOffsetArea);
</syntaxhighlight>

Rotates the prop up to a set speed.

''asName ''- internal name ''afAcc ''- acceleration ''afGoalSpeed ''- desired speed ''afAxisX ''- rotation around X axis ''afAxisY ''- rotation around Y axis ''afAxisZ ''- rotation around Z axis ''abResetSpeed ''- determines whether the speed is resetted after goal speed is reached ''asOffsetArea ''- the area to rotate around, if empty, then the center of the body is used Note: The entity you want to rotate MUST be a "StaticObject" entity!

<syntaxhighlight lang="cpp">
void StopPropMovement(string& asName);
</syntaxhighlight>

Stops all movement of a prop.

<syntaxhighlight lang="cpp">
void AddAttachedPropToProp(string& asPropName, string& asAttachName, string& asAttachFile, float afPosX, float afPosY, float afPosZ, float afRotX, float afRotY, float afRotZ);
</syntaxhighlight>

Attaches a prop to another prop.

a''sPropName''- the prop to attach another prop at ''asAttachName ''- internal name of the prop that gets attached ''asAttachFile ''- the prop that gets attached extension .ent ''afPosX ''- X position of the attach from the prop ''afPosY ''- Y position of the attach from the prop ''afPosZ ''- Z position of the attach from the prop ''afRotX ''- rotation around X axis of the attach ''afRotY ''- rotation around Y axis of the attach ''afRotZ ''- rotation around ZX axis of the attach Note: for the purposes of "AddEntityCollideCallback", attached props will not call the callback function if they collide with a "static_object" or a "StaticProp" entity type!

{{bug|''afRotZ '' is used for both the ZX rotation and the Z position of the attached prop. Unwanted rotation can be avoided by using: ''AddAttachedPropToProp(asPropName, asAttachName, asAttachFile, afPosX, afPosY, '''0''', afPosZ, '''90.0f''', afPosZ)''}}

{{bug|Attaching a breakable prop to a physically active prop, and then breaking the attached prop, will cause the game to crash, should the parent object be moved or reset.}}

<syntaxhighlight lang="cpp">
void AttachPropToProp(string& asPropName, string& asAttachName, string& asAttachFile, float afPosX, float afPosY, float afPosZ, float afRotX, float afRotY, float afRotZ);
</syntaxhighlight>

{{ReqVer|1.3}}

Attaches a prop to another prop. Fixed version of AddAttachedPropToProp.

''asPropName ''- the prop to attach another prop at ''asAttachName ''- internal name of the prop that gets attached ''asAttachFile ''- the prop that gets attached extension .ent ''afPosX ''- X position of the attach from the prop ''afPosY ''- Y position of the attach from the prop ''afPosZ ''- Z position of the attach from the prop ''afRotX ''- rotation around X axis of the attach ''afRotY ''- rotation around Y axis of the attach ''afRotZ ''- rotation around ZX axis of the attach Note: for the purposes of "AddEntityCollideCallback", attached props will not call the callback function if they collide with a "static_object" or a "StaticProp" entity type!

<syntaxhighlight lang="cpp">
void RemoveAttachedPropFromProp(string& asPropName, string& asAttachName);
</syntaxhighlight>

Detaches a prop from a prop.

<syntaxhighlight lang="cpp">
void SetPropHealth(string& asName, float afHealth);
void AddPropHealth(string& asName, float afHealth);
float GetPropHealth(string& asName);
</syntaxhighlight>

Modifies/returns the health of a prop.

<syntaxhighlight lang="cpp">
void ResetProp(string& asName);
</syntaxhighlight>

Resets a prop's state to the original one when the map was loaded.

<syntaxhighlight lang="cpp">
void PlayPropAnimation(string& asProp, string& asAnimation, float afFadeTime, bool abLoop, string& asCallback);
</syntaxhighlight>

Makes the prop play an animation and calls a function. Callback syntax: <code>void MyFunc(string &in asProp)</code>

''asProp ''- internal name of the prop ''asAnimation ''- animation to play ''afFadeTime ''- ? ''abLoop ''- determines whether the animation loops ''asCallback ''- function to call

<syntaxhighlight lang="cpp">
void AddPropForce(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
void AddPropImpulse(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
void AddBodyForce(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
void AddBodyImpulse(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
</syntaxhighlight>

These functions push objects. Note that rather high values are needed when applying ''forces'' (on the order of ~100 (weak) to ~10000 (strong)), but not impulses (values less than 10 can be appropriate). Forces are external influences, and will have different effect depending on the mass of the object they are being applied to; impulses disregard mass, and can cause objects to break, as if hit. A "Body" is a physics-related helper object, to which a force or an impulse can be applied. Entities can consist of several bodies, interconnected in various ways (you can create/examine bodies in the model editor).

''asName ''- the object to push; for bodies, use this format: "''entityName''_''bodyName''" ''afX ''- magnitude along the X-axis ''afY ''- magnitude along the Y-axis ''afZ ''- magnitude along the Z-axis ''asCoordSystem ''- determines which coordinate system is used, usually "world" All of these functions are ''additive'' - when called consecutively, for each call, the vectors defined by (afX, afY, afZ) will be added together, and a resultant force/impulse will be calculated ''before'' any physics simulation is applied to the target object.

====Connections====

<syntaxhighlight lang="cpp">
void InteractConnectPropWithRope(string& asName, string& asPropName, string& asRopeName, bool abInteractOnly, float afSpeedMul, float afToMinSpeed, float afToMaxSpeed, bool abInvert, int alStatesUsed);
</syntaxhighlight>

Connects a prop with the movement of a rope (ie. turn wheel to move rope).

''asName ''- connection name ''asPropName ''- name of prop ''asRopeName ''- name of rope ''abInteractOnly ''- ? ''afSpeedMul ''- speed multiplier of how quickly the rope moves ''afToMinSpeed ''- the slowest the rope will move when moving the prop ''afToMaxSpeed ''- the fastest the rope will move when moving the prop ''abInvert ''- whether to invert the direction the rope moves ''alStatesUsed ''- which states of the prop can interact with the rope?

<syntaxhighlight lang="cpp">
void InteractConnectPropWithMoveObject(string& asName, string& asPropName, string& asMoveObjectName, bool abInteractOnly, bool abInvert, int alStatesUsed);
</syntaxhighlight>

This one should only be used if there must be an exact correspondance to prope "amount" and the moveobject open amount. It is best used for Wheel-door connections!

<syntaxhighlight lang="cpp">
void ConnectEntities(string& asName, string& asMainEntity, string& asConnectEntity, bool abInvertStateSent, int alStatesUsed, string& asCallbackFunc);
</syntaxhighlight>

Callback syntax: <code>void MyFunc(string &in asConnectionName, string &in asMainEntity, string &in asConnectEntity, int alState)</code> State is what is sent to connection entity and will be inverted if abInvertStateSent = true!

====Lamps====

<syntaxhighlight lang="cpp">
void SetLampLit(string& asName, bool abLit, bool abEffects);
</syntaxhighlight>

(Un)lits a lamp.

''asName ''- Name of the lamp ''abLit ''- Set true if you want the lamp to be lit, set to false if you want the lamp to be unlit ''abEffects ''- If you want to have the lamp fade in/out when it gets (un)lit

====Doors====

<syntaxhighlight lang="cpp">
void SetSwingDoorLocked(string& asName, bool abLocked, bool abEffects);
void SetSwingDoorClosed(string& asName, bool abClosed, bool abEffects);
</syntaxhighlight>

Locks/closes a swing door.

<syntaxhighlight lang="cpp">
bool GetSwingDoorLocked(string& asName);
bool GetSwingDoorClosed(string& asName);
</syntaxhighlight>

Checks whether a swing door is locked/closed.

<syntaxhighlight lang="cpp">
void SetSwingDoorDisableAutoClose(string& asName, bool abDisableAutoClose);
</syntaxhighlight>

Deactivates the "auto-close" when a door is nearly closed.

<syntaxhighlight lang="cpp">
int GetSwingDoorState(string& asName);
</syntaxhighlight>

Returns an integer depending on how far the door is opened. -1 = angle is close to 0°, 1 = angle is 70% or higher of max, 0 = inbetween -1 and 1.

<syntaxhighlight lang="cpp">
void SetLevelDoorLocked(string& asName, bool abLocked);
</syntaxhighlight>

Locks a level door. Note that level doors are NOT swing doors.

<syntaxhighlight lang="cpp">
void SetLevelDoorLockedSound(string& asName, string& asSound);
</syntaxhighlight>

Determines which sound is played when interacting with a locked level door.

<syntaxhighlight lang="cpp">
void SetLevelDoorLockedText(string& asName, string& asTextCat, string& asTextEntry);
</syntaxhighlight>

Displays a message when interacting with a locked level door.

''asName ''- internal name ''asTextCat ''- the category in the .lang file ''asTextEntry ''- the entry in the .lang file

<syntaxhighlight lang="cpp">
void SetMoveObjectState(string& asName, float afState);
</syntaxhighlight>

Moves an object to a certain state.

''asName ''- internal name ''afState ''- state of the object, 0 = closed, 1 = open, values inbetween (and above, for example, the bridge_metal_vert) are valid too!

<syntaxhighlight lang="cpp">
void SetMoveObjectStateExt(string& asName, float afState, float afAcc, float afMaxSpeed, float afSlowdownDist, bool abResetSpeed);
</syntaxhighlight>

Moves an object to a certain state, extended method.

''asName ''- internal name ''afState ''- state of the object, 0 = closed, 1 = open, values inbetween are valid too! ''afAcc ''- acceleration ''afMaxSpeed ''- maximum speed ''afSlowdownDist ''- Distance to the target state before decceleration occurs. ''abResetSpeed ''- Set to True if the prop's speed should be reset before performing the movement, else the prop will accelerate from it's current speed to afMaxSpeed.

====Levers, wheels and buttons====

<syntaxhighlight lang="cpp">
void SetPropObjectStuckState(string& asName, int alState);
void SetWheelStuckState(string& asName, int alState, bool abEffects);
void SetLeverStuckState(string& asName, int alState, bool abEffects);
</syntaxhighlight>

Makes a prop<nowiki>\</nowiki>wheel<nowiki>\</nowiki>lever stuck in a certain state.

''asName ''- internal name ''alState ''- 0 = not stuck, 1 = at max, -1 = at min ''abEffects ''- use effects

<syntaxhighlight lang="cpp">
void SetWheelAngle(string& asName, float afAngle, bool abAutoMove);
</syntaxhighlight>

Moves a wheel to a certain angle.

''asName ''- internal name ''afAngle ''- angle ''abAutoMove ''- determines whether the wheel should move on its own

<syntaxhighlight lang="cpp">
void SetWheelInteractionDisablesStuck(string& asName, bool abX);
void SetLeverInteractionDisablesStuck(string& asName, bool abX);
</syntaxhighlight>

Allows the player to make a wheel/lever unstuck when interacted with.

<syntaxhighlight lang="cpp">
int GetLeverState(string& asName);
</syntaxhighlight>

Returns the state of the lever. 0 = not stuck, 1 = at max, -1 = at min

<syntaxhighlight lang="cpp">
void SetMultiSliderStuckState(string& asName, int alStuckState, bool abEffects);
</syntaxhighlight>

Makes a MultiSlider stuck in a certain state.

<syntaxhighlight lang="cpp">
void SetMultiSliderCallback(string& asName, string& asCallback);
</syntaxhighlight>

Calls a function when state changes. Callback syntax: <code>void MyFunc(string &in asEntity, int alState)</code>

<syntaxhighlight lang="cpp">
void SetButtonSwitchedOn(string& asName, bool abSwitchedOn, bool abEffects);
</syntaxhighlight>

====Sticky areas====

<syntaxhighlight lang="cpp">
void SetAllowStickyAreaAttachment(bool abX);
</syntaxhighlight>

Allows entites to stick to a StickyArea.

<syntaxhighlight lang="cpp">
void AttachPropToStickyArea(string& asAreaName, string& asProp);
void AttachBodyToStickyArea(string& asAreaName, string& asBody);
</syntaxhighlight>

Attaches a prop/body to a StickyArea.

<syntaxhighlight lang="cpp">
void DetachFromStickyArea(string& asAreaName);
</syntaxhighlight>

Detaches everything from a StickyArea.

====Enemies====

<syntaxhighlight lang="cpp">
void SetNPCAwake(string& asName, bool abAwake, bool abEffects);
</syntaxhighlight>

Activates the npc

<syntaxhighlight lang="cpp">
void SetNPCFollowPlayer(string& asName, bool abX);
</syntaxhighlight>

Sets an NPC's head to follow the player's movement's.

<syntaxhighlight lang="cpp">
void SetEnemyDisabled(string& asName, bool abDisabled);
</syntaxhighlight>

Disables an enemy.

<syntaxhighlight lang="cpp">
void SetEnemyIsHallucination(string& asName, bool abX);
</syntaxhighlight>

Makes an enemy a hallucination. Hallucinations fade to smoke when they get near the player.

<syntaxhighlight lang="cpp">
void FadeEnemyToSmoke(string& asName, bool abPlaySound);
</syntaxhighlight>

Instantly fades an enemy to smoke.

<syntaxhighlight lang="cpp">
void ShowEnemyPlayerPosition(string& asName);
</syntaxhighlight>

Makes the enemy run to the player, no matter where he is.

<syntaxhighlight lang="cpp">
void AlertEnemyOfPlayerPresence(string &in asName);
</syntaxhighlight>

{{ReqVer|1.3}}

Gives the specified enemy the player's current position and makes it search the area.

<syntaxhighlight lang="cpp">
void SetEnemyDisableTriggers(string& asName, bool abX);
</syntaxhighlight>

Enables or disables enemy triggers. If disabled, enemy will not react to player or attack.

<syntaxhighlight lang="cpp">
void AddEnemyPatrolNode(string& asName, string& asNodeName, float afWaitTime, string& asAnimation);
</syntaxhighlight>

Adds a patrol node to the enemy's path.

''asName ''- internal name of the enemy ''asNodeName ''- path node ''afWaitTime ''- time in seconds that the enemy waits at the path node before continuing ''asAnimation ''- the animation the enemy uses when reaching the path node

<syntaxhighlight lang="cpp">
void ClearEnemyPatrolNodes(string& asEnemyName);
</syntaxhighlight>

Clears the current path of patrol nodes of the enemy.

<syntaxhighlight lang="cpp">
void SetEnemySanityDecreaseActive(string &in asName, bool abX);
</syntaxhighlight>

{{ReqVer|1.3}}

Enables/disables whether an enemy activates the player's sanity drain when stared at.

''asName ''- Internal name of the enemy ''abX ''- Enabled/disabled

<syntaxhighlight lang="cpp">
void TeleportEnemyToNode(string &in asEnemyName, string &in asNodeName, bool abChangeY);
</syntaxhighlight>

{{ReqVer|1.3}}

Teleports an enemy to a specific PathNode.

''asEnemyName ''- Internal name of the enemy ''asNodeName ''- Internal name of the node to teleport to ''abChangeY ''- Whether the Y position of the node will be used when teleporting the enemy

<syntaxhighlight lang="cpp">
void TeleportEnemyToEntity(string &in asEnemyName, string &in asTargetEntity, string &in asTargetBody, bool abChangeY);
</syntaxhighlight>

{{ReqVer|1.3}}

Teleports an enemy to a specific entity.

''asEnemyName ''- Internal name of the enemy ''asTargetEntity ''- Internal name of the entity to teleport to ''asTargetBody''- Internal name of the entity's body name to teleport to. If empty, the first body will be used (might be unstable, recommended to input a body anyway) ''abChangeY ''- Whether the Y position of the node will be used when teleporting the enemy

<syntaxhighlight lang="c">
void ChangeManPigPose(string&in asName, string&in asPoseType);
</syntaxhighlight>

{{ReqVer|1.3}}

Changes the pose a specified ManPig.

''asName ''- Internal name of the enemy ''asPoseType''- Name of the ManPig pose to use. Can be "Biped" or "Quadruped"

<syntaxhighlight lang="c">
void SetTeslaPigFadeDisabled(string&in asName, bool abX);
</syntaxhighlight>

{{ReqVer|1.3}}

Enables/disables whether a specified TeslaPig should fade the player's view in and out.

''asName ''- Internal name of the enemy ''abX''- Enabled/disabled

<syntaxhighlight lang="c">
void SetTeslaPigSoundDisabled(string&in asName, bool abX);
</syntaxhighlight>

{{ReqVer|1.3}}

Enables/disables whether a specified TeslaPig should play the proximity sounds.

''asName ''- Internal name of the enemy ''abX''- Enabled/disabled

<syntaxhighlight lang="c">
void SetTeslaPigEasyEscapeDisabled(string&in asName, bool abX);
</syntaxhighlight>

{{ReqVer|1.3}}

Enables/disables whether a specified TeslaPig should be easier to escape from when hunted.

''asName ''- Internal name of the enemy ''abX''- Enabled/disabled

<syntaxhighlight lang="c">
void ForceTeslaPigSighting(string&in asName);
</syntaxhighlight>

{{ReqVer|1.3}}

Forces a TeslaPig to be visible for a short time.

''asName ''- Internal name of the enemy

<syntaxhighlight lang="c">
string& GetEnemyStateName(string &in asName);
</syntaxhighlight>

{{ReqVer|1.3}}

Returns the name of the state a specified enemy is current in. States can be Hunt, Search, Patrol, Wait, Alert, Investigate, Track and BreakDoor.

''asName ''- Internal name of the enemy

Frictional Wiki - User contributions [en]

HPL2/Engine Scripts