Frictional Games Forum (read-only) - Development Resources

Engine Scripts Plus [ES+ 1.3] - More sensical function names

Fri, 26 Oct 2018 22:44:14 +0000

One of the good things to come from SOMA / HPL3 is the naming convention used for script functions to group related things together. This was something I thought would be useful to have in HPL2, so I made this library for those wishing to use exactly that.

What's different?
Basically every single script function has been given a new name. Instead of SetEntityActive, you use Entity_SetActive. Every function has been renamed to start with a category word, then an underscore, then the description of the function. This is a standard that HPL2 has been lacking.

Why?
There are several reason why one might want this. The biggest benefit is autocompletion. In pretty much every script editor, without additional configuration, you can now start typing "Entity_" or "Game_" or "Player_" and produce a list of all functions related to that category. See screenshot from the Atom editor below.

Another reason, although more subjective, is that things are more clearly defined, so when reading your code, it can be easier to quickly see what a function does and what it affects.

How do I get started?
Because HPL2 does not allow the use of importing scripts, you will need to copy and paste the provided contents and put them into each script file you want to use this convention in. The contents are provided in a "minified" form, which means the code has been reduced in size where possible and is spread across a single line. This line is very long, so make sure you do not use line wrapping in your editor so it becomes as invisible as possible.

Click here to see the contents you need to copy, or click here to download it as a file.

Again, in case you didn't understand, all you need to do is paste the code into your .hps file, somewhere in the root level (where OnStart resides). Example:

PHP Code:
void OnStart()
{
    Entity_SetActive("chair", false);
}

/* ES+ BEGIN VERSION 1.0 */ ETC ETC ETC /* ES+ END */ 

While the code is in your script file, you can use all the functions and they should autocomplete as well, depending on your editor.

Changelog

Spoiler below!

Anything else?

If you want some trivia, it took about 4 hours to create, and is about 1000 lines non-minified. Oh, but the forum post took like 4 more.
Want to have a look at the non-minified version? Here you go.
Why so late? Yeah, I don't know. I guess I just suddenly felt like doing it. Wish I had done it years ago though, but better late than never?
Did you know that InsanityEventIsActive() actually returns a void, which practically renders this function useless?

Engine Scripts Plus reference

The documentation for each function follows here, if you need it. I won't explain them in-depth, but I will tell you which original function lies behind so you can look up the documentation for that function. Most are self-explanatory however, and they all use the exact same parameters as the originals. Here's a link to the official Engine Scripts documentation if you need it.

Before we get into it, here are all the categories that the scripts belong to:

Debug
Script
Math
String
Game
ParticleSystem
Sound
Light
Map
Timer
Effect
Player
Journal
Inventory
Entity
MoveObject
Lamp
LevelDoor
SwingDoor
Wheel
Lever
Button
MultiSlider
NPC
Enemy

Math

Quote:
PHP Code:
float Math_RandFloat(float afMin, float afMax)
= RandFloat

PHP Code:
int Math_RandInt(int alMin, int alMax)
= RandInt

PHP Code:
float Math_Sin(float afX)
= MathSin

PHP Code:
float Math_Cos(float afX)
= MathCos

PHP Code:
float Math_Tan(float afX)
= MathTan

PHP Code:
float Math_Asin(float afX)
= MathAsin

PHP Code:
float Math_Acos(float afX)
= MathAcos

PHP Code:
float Math_Atan2(float afX, float afY)
= MathAtan2

PHP Code:
float Math_Sqrt(float afX)
= MathSqrt

PHP Code:
float Math_Pow(float afBase, float afExp)
= MathPow

PHP Code:
float Math_Min(float afA, float afB)
= MathMin

PHP Code:
float Math_Max(float afA, float afB)
= MathMax

PHP Code:
float Math_Clamp(float afX, float afMin, float afMax)
= MathClamp

PHP Code:
float Math_Abs(float afX)
= MathAbs

String

Quote:
PHP Code:
bool String_Contains(string& asString, string& asSubString)
= StringContains

PHP Code:
string String_Sub(string& asString, int alStart, int alCount)
= StringSub

PHP Code:
int String_ToInt(string&in asString)
= StringToInt

PHP Code:
float String_ToFloat(string&in asString)
= StringToFloat

PHP Code:
bool String_ToBool(string&in asString)
= StringToBool

Debug

Quote:
PHP Code:
void Debug_Print(string& asString)
= Print

PHP Code:
void Debug_AddMessage(string& asString, bool abCheckForDuplicates)
= AddDebugMessage

PHP Code:
void Debug_ProgLog(string& asLevel, string& asMessage)
= ProgLog

PHP Code:
bool Debug_GetEnabled()
= ScriptDebugOn

Script

Quote:
PHP Code:
void Script_SetLocalVarInt(string& asName, int alVal)
= SetLocalVarInt

PHP Code:
void Script_AddLocalVarInt(string& asName, int alVal)
= AddLocalVarInt

PHP Code:
int Script_GetLocalVarInt(string& asName)
= GetLocalVarInt

PHP Code:
void Script_SetLocalVarFloat(string& asName, float afVal)
= SetLocalVarFloat

PHP Code:
void Script_AddLocalVarFloat(string& asName, float afVal)
= AddLocalVarFloat

PHP Code:
float Script_GetLocalVarFloat(string& asName)
= GetLocalVarFloat

PHP Code:
void Script_SetLocalVarString(string& asName, const string& asVal)
= SetLocalVarString

PHP Code:
void Script_AddLocalVarString(string& asName, string& asVal)
= AddLocalVarString

PHP Code:
string Script_GetLocalVarString(string& asName)
= GetLocalVarString

PHP Code:
void Script_SetGlobalVarInt(string& asName, int alVal)
= SetGlobalVarInt

PHP Code:
void Script_AddGlobalVarInt(string& asName, int alVal)
= AddGlobalVarInt

PHP Code:
int Script_GetGlobalVarInt(string& asName)
= GetGlobalVarInt

PHP Code:
void Script_SetGlobalVarFloat(string& asName, float afVal)
= SetGlobalVarFloat

PHP Code:
void Script_AddGlobalVarFloat(string& asName, float afVal)
= AddGlobalVarFloat

PHP Code:
float Script_GetGlobalVarFloat(string& asName)
= GetGlobalVarFloat

PHP Code:
void Script_SetGlobalVarString(string& asName, const string& asVal)
= SetGlobalVarString

PHP Code:
void Script_AddGlobalVarString(string& asName, string& asVal)
= AddGlobalVarString

PHP Code:
string Script_GetGlobalVarString(string& asName)
= GetGlobalVarString

ParticleSystem

Quote:
PHP Code:
void ParticleSystem_Preload(string& asPSFile)
= PreloadParticleSystem

PHP Code:
void ParticleSystem_CreateAtEntity(string& asPSName, string& asPSFile, string& asEntity, bool abSavePS)
= CreateParticleSystemAtEntity

Code:
void ParticleSystem_CreateAtEntityExt(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)
= CreateParticleSystemAtEntityExt

PHP Code:
void ParticleSystem_Destroy(string& asName)
= DestroyParticleSystem

PHP Code:
void ParticleSystem_StartPlayerSpawnPS(string& asPSFile)
= StartPlayerSpawnPS

PHP Code:
void ParticleSystem_StopPlayerSpawnPS()
= StopPlayerSpawnPS

Sound

Quote:
PHP Code:
void Sound_Preload(string& a)
= PreloadSound

PHP Code:
Sound_PlayAtEntity(string& a, string& b, string& c, float d, bool e)
= PlaySoundAtEntity

PHP Code:
void Sound_FadeIn(string& a, float b, bool c)
= FadeInSound

PHP Code:
void Sound_Stop(string& a, float b)
= StopSound

PHP Code:
void Sound_PlayMusic(string& a, bool b, float c, float d, int e, bool f)
= PlayMusic

PHP Code:
void Sound_StopMusic(float a, int b)
= StopMusic

PHP Code:
void Sound_FadeGlobalVolume(float a, float b)
= FadeGlobalSoundVolume

PHP Code:
void Sound_FadeGlobalSpeed(float a, float b)
= FadeGlobalSoundSpeed

Code:
void Sound_AddEffectVoice(string& asVoiceFile, string& asEffectFile, string& asTextCat, string& asTextEntry, bool abUsePosition, string& asPosEntity, float afMinDistance, float afMaxDistance)
= AddEffectVoice

PHP Code:
void Sound_StopAllEffectVoices(float afFadeOutTime)
= StopAllEffectVoices

PHP Code:
bool Sound_GetEffectVoiceActive()
= GetEffectVoiceActive

PHP Code:
void Sound_SetEffectVoiceOverCallback(string& asFunc)
= SetEffectVoiceOverCallback

PHP Code:
void Sound_PlayGuiSound(string& asSoundFile, float afVolume)
= PlayGuiSound

Light

Quote:
PHP Code:
void Light_SetVisible(string& a, bool b)
= SetLightVisible

PHP Code:
void Light_FadeTo(string& asLightName, float afR, float afG, float afB, float afA, float afRadius, float afTime)
= FadeLightTo

PHP Code:
void Light_SetFlickerActive(string& asLightName, bool abActive)
= SetLightFlickerActive

Game

Quote:
PHP Code:
void Game_StartCredits(string& asMusic, bool abLoopMusic, string& asTextCat, string& asTextEntry, int alEndNum)
= StartCredits

PHP Code:
void Game_StartDemoEnd()
= StartDemoEnd

PHP Code:
void Game_AutoSave()
= AutoSave

PHP Code:
void Game_SetupLoadScreen(string&asTextCat, string&asTextEntry, int alRandomNum, string&asImageFile)
= SetupLoadScreen

PHP Code:
void Game_SetDeathHint(string& asTextCategory, string& asTextEntry)
= SetDeathHint

PHP Code:
void Game_DisableDeathStartSound()
= DisableDeathStartSound

PHP Code:
void Game_GiveHint(string& asName, string& asMessageCat, string& asMessageEntry, float afTimeShown)
= GiveHint

PHP Code:
void Game_RemoveHint(string& asName)
= RemoveHint

PHP Code:
void Game_BlockHint(string& asName)
= BlockHint

PHP Code:
void Game_UnblockHint(string& asName)
= UnBlockHint

PHP Code:
void Game_CreateDataCache()
= CreateDataCache

PHP Code:
void Game_DestroyDataCache()
= DestroyDataCache

Map

Quote:
Code:
void Map_CheckPoint(string& asName, string& asStartPos, string& asCallback, string& asDeathHintCat, string& asDeathHintEntry)

= CheckPoint

PHP Code:
void Map_Change(string& asMapName, string& asStartPos, string& asStartSound, string& asEndSound)
= ChangeMap

PHP Code:
void Map_ClearSavedMaps()
= ClearSavedMaps

PHP Code:
void Map_SetDisplayNameEntry(string& asNameEntry)
= SetMapDisplayNameEntry

PHP Code:
void Map_SetSkyboxActive(bool abActive)
= SetSkyBoxActive

PHP Code:
void Map_SetSkyboxTexture(string & asTexture)
= SetSkyboxTexture

PHP Code:
void Map_SetSkyboxColor(float afR, float afG, float afB, float afA)
= SetSkyboxColor

PHP Code:
void Map_SetFogActive(bool abActive)
= SetFogActive

PHP Code:
void Map_SetFogColor(float afR, float afG, float afB, float afA)
= SetFogColor

PHP Code:
void Map_SetFogProperties(float afStart, float afEnd, float afFalloffExp, bool abCulling)
= SetFogProperties

Timer

Quote:
PHP Code:
void Timer_Add(string& asName, float afTime, string& asFunction)
= AddTimer

PHP Code:
void Timer_Remove(string& asName)
= RemoveTimer

PHP Code:
float Timer_GetTimeLeft(string& asName)
= GetTimerTimeLefT

Effect

Quote:
PHP Code:
void Effect_FadeOut(float afTime)
= FadeOut

PHP Code:
void Effect_FadeIn(float afTime)
= FadeIn

PHP Code:
void Effect_FadeImageTrailTo(float afAmount, float afSpeed)
= FadeImageTrailTo

PHP Code:
void Effect_FadeSepiaColorTo(float afAmount, float afSpeed)
= FadeSepiaColorTo

PHP Code:
void Effect_FadeRadialBlurTo(float afSize, float afSpeed)
= FadeRadialBlurTo

PHP Code:
void Effect_SetRadialBlurStartDist(float afStartDist)
= SetRadialBlurStartDist

PHP Code:
void Effect_StartFlash(float afFadeIn, float afWhite, float afFadeOut)
= StartEffectFlash

PHP Code:
void Effect_StartEmotionFlash(string& asTextCat, string& asTextEntry, string& asSound)
= StartEffectEmotionFlash

PHP Code:
bool Effect_GetFlashbackIsActive()
= GetFlashbackIsActive

PHP Code:
void Effect_StartScreenShake(float afAmount, float afTime, float afFadeInTime, float afFadeOutTime)
= StartScreenShake

PHP Code:
void Effect_SetInDarknessEffectsActive(bool abX)
= SetInDarknessEffectsActive

PHP Code:
void Effect_SetInsanitySetEnabled(string& asSet, bool abX)
= SetInsanitySetEnabled

PHP Code:
void Effect_StartInsanityEvent(string &in asEventName)
= StartInsanityEvent

PHP Code:
void Effect_StartRandomInsanityEvent()
= StartRandomInsanityEvent

PHP Code:
void Effect_StopCurrentInsanityEvent()
= StopCurrentInsanityEvent

PHP Code:
void Effect_FadeFOVMulTo(float afX, float afSpeed)
= FadePlayerFOVMulTo

PHP Code:
void Effect_FadeAspectMulTo(float afX, float afSpeed)
= FadePlayerAspectMulTo

PHP Code:
void Effect_FadePlayerRollTo(float afX, float afSpeedMul, float afMaxSpeed)
= FadePlayerRollTo

PHP Code:
void Effect_MovePlayerHeadPos(float afX, float afY, float afZ, float afSpeed, float afSlowDownDist)
= MovePlayerHeadPos

PHP Code:
void Effect_SetMessage(string& asTextCategory, string& asTextEntry, float afTime)
= SetMessage

Player

Quote:
PHP Code:
void Player_SetActive(bool abActive)
= SetPlayerActive

PHP Code:
void Player_ChangeStateToNormal()
= ChangePlayerStateToNormal

PHP Code:
void Player_SetCrouching(bool abCrouch)
= SetPlayerCrouching

PHP Code:
void Player_AddPlayerBodyForce(float afX, float afY, float afZ, bool abUseLocalCoords)
= AddPlayerBodyForce

PHP Code:
void Player_ShowCrossHairIcons(bool abX)
= ShowPlayerCrossHairIcons

PHP Code:
void Player_SetSanity(float afSanity)
= SetPlayerSanity

PHP Code:
void Player_AddSanity(float afSanity)
= AddPlayerSanity

PHP Code:
float Player_GetSanity()
= GetPlayerSanity

PHP Code:
void Player_SetHealth(float afHealth)
= SetPlayerHealth

PHP Code:
void Player_AddPlayerHealth(float afHealth)
= AddPlayerHealth

PHP Code:
float Player_GetHealth()
= GetPlayerHealth

PHP Code:
void Player_SetLampOil(float afOil)
= SetPlayerLampOil

PHP Code:
void Player_AddLampOil(float afOil)
= AddPlayerLampOil

PHP Code:
float Player_GetLampOil()
= GetPlayerLampOil

PHP Code:
float Player_GetSpeed()
= GetPlayerSpeed

PHP Code:
float Player_GetYSpeed()
= GetPlayerYSpeed

PHP Code:
void Player_SetSanityDrainDisabled(bool abX)
= SetSanityDrainDisabled

PHP Code:
void Player_GiveSanityBoost()
= GiveSanityBoost

PHP Code:
void Player_GiveSanityBoostSmall()
= GiveSanityBoostSmall

PHP Code:
void Player_GiveSanityDamage(float afAmount, bool abUseEffect)
= GiveSanityDamage

PHP Code:
void Player_GiveDamage(float afAmount, string& asType, bool abSpinHead, bool abLethal)
= GivePlayerDamage

PHP Code:
void Player_StartLookAt(string& asEntityName, float afSpeedMul, float afMaxSpeed, string& asAtTargetCallback)
= StartPlayerLookAt

PHP Code:
void Player_StopLookAt()
= StopPlayerLookAt

PHP Code:
void Player_SetMoveSpeedMul(float afMul)
= SetPlayerMoveSpeedMul

PHP Code:
void Player_SetRunSpeedMul(float afMul)
= SetPlayerRunSpeedMul

PHP Code:
void Player_SetLookSpeedMul(float afMul)
= SetPlayerLookSpeedMul

PHP Code:
void Player_SetJumpForceMul(float afMul)
= SetPlayerJumpForceMul

PHP Code:
void Player_SetJumpDisabled(bool abX)
= SetPlayerJumpDisabled

PHP Code:
void Player_SetCrouchDisabled(bool abX)
= SetPlayerCrouchDisabled

PHP Code:
void Player_Teleport(string& asStartPosName)
= TeleportPlayer

PHP Code:
void Player_SetLanternActive(bool abX, bool abUseEffects)
= SetLanternActive

PHP Code:
void Player_SetLanternDisabled(bool abX)
= SetLanternDisabled

PHP Code:
bool Player_GetLanternActive()
= GetLanternActive

PHP Code:
void Player_SetLanternLitCallback(string& asCallback)
= SetLanternLitCallback

PHP Code:
void Player_MoveForward(float afAmount)
= MovePlayerForward

PHP Code:
void Player_SetFallDamageDisabled(bool abX)
= SetPlayerFallDamageDisabled

PHP Code:
void Player_SetPos(float afX, float afY, float afZ)
= SetPlayerPos

PHP Code:
float Player_GetPosX()
= GetPlayerPosX

PHP Code:
float Player_GetPosY()
= GetPlayerPosY

PHP Code:
float Player_GetPosZ()
= GetPlayerPosZ

Journal

Quote:
PHP Code:
void Journal_AddNote(string& asNameAndTextEntry, string& asImage)
= AddNote

PHP Code:
void Journal_AddDiary(string& asNameAndTextEntry, string& asImage)
= AddDiary

PHP Code:
void Journal_ReturnOpen(bool abOpenJournal)
= ReturnOpenJournal

PHP Code:
void Journal_AddQuest(string& asName, string& asNameAndTextEntry)
= AddQuest

PHP Code:
void Journal_CompleteQuest(string& asName, string& asNameAndTextEntry)
= CompleteQuest

PHP Code:
bool Journal_GetQuestIsAdded(string& asName)
= QuestIsAdded

PHP Code:
void Journal_SetNumberOfQuestsInMap(int alNumberOfQuests)
= SetNumberOfQuestsInMap

Inventory

Quote:
PHP Code:
void Inventory_Exit()
= ExitInventory

PHP Code:
void Inventory_SetDisabled(bool abX)
= SetInventoryDisabled

PHP Code:
void Inventory_SetMessage(string& asTextCategory, string& asTextEntry, float afTime)
= SetInventoryMessage

PHP Code:
void Inventory_GiveItem(string& asName, string& asType, string& asSubTypeName, string& asImageName, float afAmount)
= GiveItem

PHP Code:
void Inventory_GiveItemFromFile(string& asName, string& asFileName)
= GiveItemFromFile

PHP Code:
void Inventory_RemoveItem(string& asName)
= RemoveItem

PHP Code:
bool Inventory_HasItem(string& asName)
= HasItem

PHP Code:
void Inventory_AddCombineCallback(string& asName, string& asItemA, string& asItemB, string& asFunction, bool abAutoRemove)
= AddCombineCallback

PHP Code:
void Inventory_RemoveCombineCallback(string& asName)
= RemoveCombineCallback

PHP Code:
void Inventory_AddUseItemCallback(string& asName, string& asItem, string& asEntity, string& asFunction, bool abAutoDestroy)
= AddUseItemCallback

PHP Code:
void Inventory_RemoveUseItemCallback(string& asName)
= RemoveUseItemCallback

Entity

Quote:
PHP Code:
void Entity_SetActive(string& asName, bool abActive)
= SetEntityActive

PHP Code:
void Entity_SetVisible(string& asName, bool abVisible)
= SetEntityVisible

PHP Code:
bool Entity_GetExists(string& asName)
= GetEntityExists

PHP Code:
void Entity_SetCustomFocusCrossHair(string& asName, string& asCrossHair)
= SetEntityCustomFocusCrossHair

PHP Code:
void Entity_CreateAtArea(string& asEntityName, string& asEntityFile, string& asAreaName, bool abFullGameSave)
= CreateEntityAtArea

Code:
void Entity_Replace(string &in asName, string &in asBodyName, string &in asNewEntityName, string &in asNewEntityFile, bool abFullGameSave)

= ReplaceEntity

PHP Code:
void Entity_PlaceAtEntity(string &in asName, string &in asTargetEntity, string &in asTargetBodyName, bool abUseRotation)
= PlaceEntityAtEntity

PHP Code:
void Entity_SetPos(string &in asName, float afX, float afY, float afZ)
= SetEntityPos

PHP Code:
float Entity_GetPosX(string &in asName)
= GetEntityPosX

PHP Code:
float Entity_GetPosY(string &in asName)
= GetEntityPosY

PHP Code:
float Entity_GetPosZ(string &in asName)
= GetEntityPosZ

PHP Code:
void Entity_SetPlayerLookAtCallback(string& asName, string& asCallback, bool abRemoveWhenLookedAt)
= SetEntityPlayerLookAtCallback

PHP Code:
void Entity_SetPlayerInteractCallback(string& asName, string& asCallback, bool abRemoveOnInteraction)
= SetEntityPlayerInteractCallback

PHP Code:
void Entity_SetCallbackFunc(string& asName, string& asCallback)
= SetEntityCallbackFunc

PHP Code:
void Entity_SetConnectionStateChangeCallback(string& asName, string& asCallback)
= SetEntityConnectionStateChangeCallback

PHP Code:
void Entity_SetInteractionDisabled(string& asName, bool abDisabled)
= SetEntityInteractionDisabled

PHP Code:
void Entity_BreakJoint(string& asName)
= BreakJoint

Code:
void Entity_AddCollideCallback(string& asParentName, string& asChildName, string& asFunction, bool abDeleteOnCollide, int alStates)
= AddEntityCollideCallback

PHP Code:
void Entity_RemoveCollideCallback(string& asParentName, string& asChildName)
= RemoveEntityCollideCallback

PHP Code:
bool Entity_GetCollide(string& asEntityA, string& asEntityB)
= GetEntitiesCollide

PHP Code:
void Entity_SetBodyMass(string &in asName, float afMass)
= SetBodyMass

PHP Code:
float Entity_GetBodyMass(string &in asName)
= GetBodyMass

PHP Code:
void Entity_SetEffectActive(string& asName, bool abActive, bool abFadeAndPlaySounds)
= SetPropEffectActive

PHP Code:
void Entity_SetActiveAndFade(string& asName, bool abActive, float afFadeTime)
= SetPropActiveAndFade

PHP Code:
void Entity_SetStaticPhysics(string& asName, bool abX)
= SetPropStaticPhysics

PHP Code:
bool Entity_GetInteractedWith(string& asName)
= GetPropIsInteractedWith

Code:
void Entity_RotateToSpeed(string& asName, float afAcc, float afGoalSpeed, float afAxisX, float afAxisY, float afAxisZ, bool abResetSpeed, string& asOffsetArea)

= RotatePropToSpeed

PHP Code:
void Entity_StopMovement(string& asName)
= StopPropMovement

Code:
void Entity_AttachEntity(string& asPropName, string& asAttachName, string& asAttachFile, float afPosX, float afPosY, float afPosZ, float afRotX, float afRotY, float afRotZ)

= AttachPropToProp

PHP Code:
void Entity_RemoveAttachedEntity(string& asPropName, string& asAttachName)
= RemoveAttachedPropFromProp

PHP Code:
void Entity_SetHealth(string& asName, float afHealth)
= SetPropHealth

PHP Code:
void Entity_AddHealth(string& asName, float afHealth)
= AddPropHealth

PHP Code:
float Entity_GetHealth(string& asName)
= GetPropHealth

PHP Code:
void Entity_Reset(string& asName)
= ResetProp

PHP Code:
void Entity_PlayAnimation(string& asProp, string& asAnimation, float afFadeTime, bool abLoop, string& asCallback)
= PlayPropAnimation

PHP Code:
void Entity_AddForce(string& asName, float afX, float afY, float afZ, string& asCoordSystem)
= AddPropForce

PHP Code:
void Entity_AddImpulse(string& asName, float afX, float afY, float afZ, string& asCoordSystem)
= AddPropImpulse

PHP Code:
void Entity_AddBodyForce(string& asName, float afX, float afY, float afZ, string& asCoordSystem)
= AddBodyForce

PHP Code:
void Entity_AddBodyImpulse(string& asName, float afX, float afY, float afZ, string& asCoordSystem)
= AddBodyImpulse

Code:
void Entity_ConnectWithRope(string& asName, string& asPropName, string& asRopeName, bool abInteractOnly, float afSpeedMul, float afToMinSpeed, float afToMaxSpeed, bool abInvert, int alStatesUsed)

= InteractConnectPropWithRope

Code:
void Entity_ConnectWithMoveObject(string& asName, string& asPropName, string& asMoveObjectName, bool abInteractOnly, bool abInvert, int alStatesUsed)

= InteractConnectPropWithMoveObject

Code:
void Entity_ConnectEntities(string& asName, string& asMainEntity, string& asConnectEntity, bool abInvertStateSent, int alStatesUsed, string& asCallbackFunc)

= ConnectEntities

PHP Code:
void Entity_SetStuckState(string& asName, int alState)
= SetPropObjectStuckState

PHP Code:
void Entity_SetAllowStickyAreaAttachment(bool abX)
= SetAllowStickyAreaAttachment

PHP Code:
void Entity_AttachToStickyArea(string& asAreaName, string& asProp)
= AttachPropToStickyArea

PHP Code:
void Entity_AttachBodyToStickyArea(string& asAreaName, string& asBody)
= AttachBodyToStickyArea

PHP Code:
void Entity_DetachFromStickyArea(string& asAreaName)
= DetachFromStickyArea

MoveObject

Quote:
PHP Code:
void MoveObject_SetState(string& asName, float afState)
= SetMoveObjectState

Code:
void MoveObject_SetStateExt(string& asName, float afState, float afAcc, float afMaxSpeed, float afSlowdownDist, bool abResetSpeed)

= SetMoveObjectStateExt

Lamp

Quote:
PHP Code:
void Entity_SetLampLit(string& asName, bool abLit, bool abEffects)
= SetLampLit

SwingDoor

Quote:
PHP Code:
void SwingDoor_SetLocked(string& asName, bool abLocked, bool abEffects)
= SetSwingDoorLocked

PHP Code:
void SwingDoor_SetClosed(string& asName, bool abClosed, bool abEffects)
= SetSwingDoorClosed

PHP Code:
bool SwingDoor_GetLocked(string& asName)
= GetSwingDoorLocked

PHP Code:
bool SwingDoor_GetClosed(string& asName)
= GetSwingDoorClosed

PHP Code:
void SwingDoor_SetDisableAutoClose(string& asName, bool abDisableAutoClose)
= SetSwingDoorDisableAutoClose

PHP Code:
int SwingDoor_GetState(string& asName)
= GetSwingDoorState

LevelDoor

Quote:
PHP Code:
void LevelDoor_SetLocked(string& asName, bool abLocked)
= SetLevelDoorLocked

PHP Code:
void LevelDoor_SetLockedSound(string& asName, string& asSound)
= SetLevelDoorLockedSound

PHP Code:
void LevelDoor_SetLockedText(string& asName, string& asTextCat, string& asTextEntry)
= SetLevelDoorLockedText

Wheel

Quote:
PHP Code:
void Wheel_SetStuckState(string& asName, int alState, bool abEffects)
= SetWheelStuckState

PHP Code:
void Wheel_SetAngle(string& asName, float afAngle, bool abAutoMove)
= SetWheelAngle

PHP Code:
void Wheel_SetInteractionDisablesStuck(string& asName, bool abX)
= SetWheelInteractionDisablesStuck

Lever

Quote:
PHP Code:
void Lever_SetStuckState(string& asName, int alState, bool abEffects)
= SetLeverStuckState

PHP Code:
void Lever_SetInteractionDisablesStuck(string& asName, bool abX)
= SetLeverInteractionDisablesStuck

PHP Code:
int Lever_GetState(string& asName)
= GetLeverState

Button

Quote:
PHP Code:
void Button_SetSwitchedOn(string& asName, bool abSwitchedOn, bool abEffects)
= SetButtonSwitchedOn

MultiSlider

Quote:
PHP Code:
void MultiSlider_SetStuckState(string& asName, int alStuckState, bool abEffects)
= SetMultiSliderStuckState

PHP Code:
void MultiSlider_SetCallback(string& asName, string& asCallback)
= SetMultiSliderCallback

NPC

Quote:
PHP Code:
void NPC_SetAwake(string& asName, bool abAwake, bool abEffects)
= SetNPCAwake

PHP Code:
void NPC_SetFollowPlayer(string& asName, bool abX)
= SetNPCFollowPlayer

Enemy

Quote:
PHP Code:
void Enemy_SetDisabled(string& asName, bool abDisabled)
= SetEnemyDisabled

PHP Code:
void Enemy_SetIsHallucination(string& asName, bool abX)
= SetEnemyIsHallucination

PHP Code:
void Enemy_FadeToSmoke(string& asName, bool abPlaySound)
= FadeEnemyToSmoke

PHP Code:
void Enemy_ShowPlayerPosition(string& asName)
= ShowEnemyPlayerPosition

PHP Code:
void Enemy_AlertPlayerPresence(string &in asName)
= AlertEnemyOfPlayerPresence

PHP Code:
void Enemy_SetTriggersDisabled(string& asName, bool abX)
= SetEnemyDisableTriggers

PHP Code:
void Enemy_AddPatrolNode(string& asName, string& asNodeName, float afWaitTime, string& asAnimation)
= AddEnemyPatrolNode

PHP Code:
void Enemy_ClearPatrolNodes(string& asEnemyName)
= ClearEnemyPatrolNodes

PHP Code:
void Enemy_SetSanityDecreaseActive(string &in asName, bool abX)
= SetEnemySanityDecreaseActive

PHP Code:
void Enemy_TeleportToNode(string &in asEnemyName, string &in asNodeName, bool abChangeY)
= TeleportEnemyToNode

PHP Code:
void Enemy_TeleportToEntity(string &in asEnemyName, string &in asTargetEntity, string &in asTargetBody, bool abChangeY)
= TeleportEnemyToEntity

PHP Code:
void Enemy_ChangeManPigPose(string&in asName, string&in asPoseType)
= ChangeManPigPose

PHP Code:
void Enemy_SetTeslaPigFadeDisabled(string&in asName, bool abX)
= SetTeslaPigFadeDisabled

PHP Code:
void Enemy_SetTeslaPigSoundDisabled(string&in asName, bool abX)
= SetTeslaPigSoundDisabled

PHP Code:
void Enemy_SetTeslaPigEasyEscapeDisabled(string&in asName, bool abX)
= SetTeslaPigEasyEscapeDisabled

PHP Code:
void Enemy_ForceTeslaPigSighting(string&in asName)
= ForceTeslaPigSighting

PHP Code:
string Enemy_GetStateName(string &in asName)
= GetEnemyStateName

[CUSTOM ENTITY]: Red Wax Candle

Thu, 11 Oct 2018 17:30:32 +0000

So I created a custom asset for my custom story Order of the Skull, and I figured I might as well share it, as it was a pain to make, so I don't want to restrict it to only my mod. Basically its a re-textured version of the candle_floor entity with red wax, I hope you find it useful!

To download the file, click the attachment named "HappyMatt12345's_Red_Candle.rar", feel free to use it, as long as I am credited properly.

To use it, place the folder in the .rar file in your "entities" folder or elseware as you desire, as long as you remember to pack it with your mod when its complete.

  RedCandleCustom.png (Size: 446.55 KB / Downloads: 668)

  RedCandleCustomME.png (Size: 72.49 KB / Downloads: 576)

  HappyMatt12345's Red Candle.rar (Size: 361.12 KB / Downloads: 549)

[Request] Paraffin Lantern from Penumbra - Overture

Fri, 14 Apr 2017 05:14:58 +0000

Hi, i'm looking for an Paraffin Lantern entity/item for my project. I already tried making it myself but i can't select it by clicking on it on the Level Editor (only when dragging a box over it), and when starting a map with it the game crashes (BlackBox). If you can help me, please reply and, if you have that entity or you have enough time to do it, reply as well with an link.

HPL2 Editors - Dark skin

Mon, 23 Jan 2017 10:10:55 +0000

I've made a dark versioned skin of the HPL2 editor suite, which you can download and apply if you like to play with the editors in the dark. Installation is quite simple as well.

If you're interested in an HPL3 version, I have one as well.

Here's a preview of how it looks:

[Download]

Installation instructions are found in the readme.

I found an issue though:

The color picker's brightness is offset here as well, similarly to HPL3, so the picker will look off.

Enjoy!

Reg_Zombie Monster

Tue, 03 Jan 2017 12:05:57 +0000

About
This monster was used in my old custom story Regression. Since then, the sounds had been fixed and values adjusted so the monster is no longer too fast.

How to use the monster

Extract the "sounds", "music" and "entities" folders into your Amnesia directory. Same folders should already exist in that directory. This action should not replace any files, only merge them.
After this action, be sure to restart Level Editor as well as the game itself if it was open before.
In Level Editor, the monster can be found in Entities > Reg_Zombie

How to include the monster with your custom story

Extract the "sounds", "music" and "entities" folders into your custom story's folder. It's the same folder where your extra_english.lang file is.
(optional) Check your custom story with AURORA Asset Validation Tool to make sure no entities are missing.

Downloads
Download

Help Editing default wall files

Sun, 16 Oct 2016 22:10:37 +0000

I am trying to use CrazyBump on the mansionbase walls. But, I can not figure out how to make it work. I have the color, normal, and spec maps. The only thing I cant figure out is editing the .dae file. Right now, in the level editor the custom wall shows up in the menu, but does not show when created.

[Request] All statue entities

Sun, 16 Oct 2016 04:06:18 +0000

Does anyone have a file that includes all the statue entities that they used in the game, or at least able to provide me with some to use in my cs. Thanks all

Working AMFP Phone Box for Amnesia (download)

Sat, 15 Oct 2016 14:13:56 +0000

I can understand that people had issues porting this particular entity over to TDD, though it was quite fun to do I must admit. So here it is folks.

There are some things you need to know if you want to use this entity though.

There are 2 entities you must place in your level, one being the phone box itself, and the other being the green light entity. The light must have the same internal name as the phone appended with _light. Remember to set the default state to "unlit".
You must include the script below in each level you use the phone.

You could always script your own version of the phone, like if you need to tweak anything in the "internal" (so to speak) coding I did, feel free to do so, but for most applications, what I have should be perfectly fine.

You can download the entity here

Here's a vid btw.

Ok, on to the instructions:

First off, paste this script anywhere into your level's .hps file (for example at the very bottom). You're not required to read the script or know how it works, but it MUST be included if you wish to use the function below.

Spoiler below!

PHP Code:
////////////////////////
// PHONE SCRIPT       //
// Written by Mudbill //
////////////////////////
void StartPhoneRinging (string &in asEntity, 
                        string[] &in asAudioFiles, 
                        string &in asSubCat, 
                        string[] &in asSubEntries, 
                        string &in asCallback) {
    SetLocalVarInt("_PhoneFilesTotal", asAudioFiles.length());
    SetLocalVarInt("_PhoneEntriesTotal", asSubEntries.length());
    for(int i = 0; i < asAudioFiles.length(); i++)
        SetLocalVarString("_PhoneAudioFile_"+i, asAudioFiles[i]);
    for(int i = 0; i < asSubEntries.length(); i++)
        SetLocalVarString("_PhoneSubEntry_"+i, asSubEntries[i]);
    SetLocalVarString("_PhoneEnt", asEntity);
    SetLocalVarString("_PhoneCallback", asCallback);
    SetLocalVarString("_PhoneCat", asSubCat);
    SetEntityPlayerInteractCallback(asEntity, "_PhoneStartCall", true);
    _PhoneRingLoop("ring");
}
void _PhoneRingLoop(string &in asTimer) {
    PlayPropAnimation(GetLocalVarString("_PhoneEnt"), "hammer", 0.0f, false, "");
    PlaySoundAtEntity("ring", "phone_ring", GetLocalVarString("_PhoneEnt"), 0.0f, false);
    AddTimer(asTimer, 5.0f, "_PhoneRingLoop");
}
void _PhoneStartCall(string &in asEntity) {
    SetLampLit(asEntity+"_light", true, false);
    PlaySoundAtEntity("", "phone_up", asEntity, 0.0f, false);
    PlayPropAnimation(asEntity, "switchon", 0.0f, false, "_PhoneCall");
    StopSound("ring", 0.0f);
    RemoveTimer("ring");
}
void _PhoneCall(string &in asProp) {    
    for(int i = 0; i < GetLocalVarInt("_PhoneFilesTotal"); i++)
        AddEffectVoice( GetLocalVarString("_PhoneAudioFile_"+i), 
                        "", 
                        GetLocalVarString("_PhoneCat"), 
                        GetLocalVarString("_PhoneSubEntry_"+i), 
                        true, 
                        asProp, 
                        0.0f, 
                        10.0f);
    SetEffectVoiceOverCallback("_PhoneEndCall");
}
void _PhoneEndCall() {
    SetLampLit(GetLocalVarString("_PhoneEnt")+"_light", false, false);
    PlayPropAnimation(GetLocalVarString("_PhoneEnt"), "switchoff", 0.0f, false, "");
    PlaySoundAtEntity("", "phone_down", GetLocalVarString("_PhoneEnt"), 0.0f, false);
    AddTimer(GetLocalVarString("_PhoneEnt"), 0.0f, GetLocalVarString("_PhoneCallback"));
}
//////////////////////
// END PHONE SCRIPT //
////////////////////// 

Once you have that script, you can use this function to configure your phone box:

PHP Code:
void StartPhoneRinging(string &in asEntity, string[] &in asAudioFiles, string &in asSubCat, string[] &in asSubEntries, 
string &in asCallback); 

Callback syntax: void MyFunc(string &in asEntity)

asEntity - The phone box entity.
asAudioFiles - An array containing a list of all the audio files you wish to play when the phone is picked up.
asSubCat - The .lang category for your subtitles.
asSubEntries - An array containing a list of all the subtitle entries to display. I recommend it has the same length as the audio files.
asCallback - A callback that is called when the entire phone sequence has finished.

If you're unsure how to use the arrays, create them like so:

PHP Code:
string[] example_array = {"item1", "item2", "item3"}; 

Then you just give the function this example_array as an argument. Do this for both the audio files and subtitle entries.

Here's an example of how you can implement it.

Spoiler below!

Oh, and as for installation, you place the "phone_box" folder within the downloaded archive inside your Amnesia/entities/custom/ folder (create a custom folder if you wish).
Remember to also keep a copy of the phone box within your mod's or custom story's directories when you export it.

If you use this, then credits would be nice.

[Request] Car model?

Sat, 03 Sep 2016 21:17:16 +0000

Hey, I need a car model for my WIP custom story.
I don't really care what car, just a vehicle model of any kind.
I remember a few Custom Stories that had car models.
Are there any out there?

Font Fix for LevelEditor/ModelEditor

Mon, 15 Aug 2016 21:49:19 +0000

Basically it changes the font face the editors use.
The change is very convenient and noticeable, it's easier to read and more comfortable.

Original:

Spoiler below!

New:

Spoiler below!

Mediafire: Download
Unzip&Replace inside /fonts
(Make a backup of fonts/vera.fnt if you want to have a backup of the original.)

Mouse pointer
Also, if you want to get rid of the boring mouse pointer in the editors you can use the amnesia one.
Simply replace this image /gui/default/gui_def_pointer_normal.tga
with this one: /gui/main_menu/gui_amn_mm_pointer_normal.tga.

Regards.

[CUSTOM ASSETS] Slanderous' Thread of Stuff

Fri, 12 Aug 2016 20:41:46 +0000

Hi yall. Since my latest mod is pretty much almost done, I've decided to share some entities from the original game that I've retextured particularly for my own needs. Figured out it'd be nice to upload them seperately from the whole mod as well, so that modders can grab 'em easily without having to download my whole custom story.

The pack consists of:

-2 crystal eagles (green and blue, add some bilboards and lights to em to make them look cool!)
-Retextured table
-Retextured book
-Retextured layout board
-Alternative castlebase tiled floor
-Alternative castlebase floor
-Recoloured shelf
-Recoloured clock
-Recoloured breakable planks (/w broken version)
-Misc entities I edited; orange bridge torches, colorful candles (3)

Preview

Spoiler below!

Download

Looking for some old models

Sat, 13 Feb 2016 07:33:43 +0000

The actual download for these models has been deleted, but they were publicly available on moddb and indiedb.

Spoiler below!

I'm not sure where to find them now - I'm wondering if anyone has them stashed away to share, or knows a custom story that contains them? Specifically I'm trying to find the armchairs in the top left corner of both images. Please and thanks.

High Heels Pack [ITEMS & ENTITIES]

Fri, 22 Jan 2016 21:20:15 +0000

Hey there,
so I've created some models of high heels (one with variations) and would like to share those with you, so you can use it in your work if you want/need to.

What's in the pack, man... What's in the pack? Get it?

There are 7 models of High Heel shoes with an Item Version for each color.

They are already in .ent and has their hitbox set so the space between the heel and sole is empty.

Items do have their Icons ready.

But... Why?

I just really like making footwear models. Call me whatever you want, I like it and that's why I do it.

I saw some people make mods in the modern environment or future and this might be useful to them.

You can come up with some interesting puzzles.

Use it however your little heart desires.

DOWNLOAD

There are TWO versions. The main version has every color variation separate so you can choose which of them you want. IT CONTAINS TUTORIAL FOR INSTALLATION
The Unorganized version has all the models in one directory. IT DOESN'T CONTAIN TUTORIAL - Recommended only for people who know what they're doing.

ORGANIZED VERSION + TUTORIAL (RECOMMENDED)
DOWNLOAD (Dropbox)

UNORGANIZED VERSION (No tutorial)
DOWNLOAD (Dropbox)

Snow footsteps, download.

Thu, 12 Nov 2015 15:57:26 +0000

A member asked for some so here they are.

15 .ogg files for stepping in snow.

http://www.filedropper.com/footstepsnow

Amnesia Custom Horror Music (Closed)

Sun, 18 Oct 2015 06:22:35 +0000

Due to lack of interest within Amnesia, there will be no further updates.

All compositions are composed by me. I do not own the samples and sounds, all respects go to SoundIron. I just arrange, mix, and edit as I see fit. You are free to use the track in which ever way possible. Credit is very much welcome if you use the track(s).

I might or might not keep this thread going with more tracks. Depending on my schedule of well, life. But if I do, you are sure to hear something new and unique. Weather it be downright horrifying, or melodic and uneasy of tension.

How to download:

Click on the soundcloud link, it will take you to your desired track. There is a little down arrow icon right under the comment box. Enjoy the horror tracks!

Track 1: The Ancient Foreboding

The tension rises. That haunted ancient sound that tribes feared the most, what men feared the most. It crawls under your skin.

https://soundcloud.com/amnesiacustomhorr...foreboding

Circular Saw (With sounds)

Sat, 17 Oct 2015 22:06:56 +0000

This is a circular saw.
It has 2 sounds files.
1 is for a constant loop for like 8 minuts, other one is beggining, I don't prefer using the beginning one since it doesn't even fit with the constant loop one.

It includes a Circular Saw, and a "pipe" to attach it to the saw.
Pretty funny imo how it works haha.
Video: https://www.youtube.com/watch?v=3iZT7ZGXDz0
I'm really sorry for the first seconds. A glitch happened lol.

Download Link:
http://www.mediafire.com/download/5u0bqf...w_Pack.rar

Animated People/Man?!

Tue, 14 Jul 2015 14:19:47 +0000

Is there any custom stories/fc with animated man that I can use??
In my storyline, You have to talk straight to your dad.
And no there is no other abilities because your dad is going to do something to you, what is quite not possible at a distance.

What I need is a man, that has some animations (and that because I can't animate atm)
and the aniamtions are like... that they are talking.
some hand moves etc.
I really need this kind of thing to complete my story thoughts.
If this won't work I have to choose the other way around, and I don't want to do that now
(If any of you want to see my work, search : Great Leap Forward at moddb, It doesn't show the full cs there, but most that my cs include

Lava_Rock Moving up.

Fri, 19 Jun 2015 19:36:40 +0000

https://www.youtube.com/watch?v=zgi2XjYf2lI

Something I made
If someone wants this, ask I'll post the download later.
btw, the onyl thing attached to this is the fire.
scripting is for yourself

cellarbase extension doorway?

Mon, 01 Jun 2015 19:29:46 +0000

Who can make a cellarbase default_extension doorway? I use the original doorway and it looks not so well.

[WIP] Egyptian kit

Sat, 30 May 2015 02:31:32 +0000

Hi guys,

I started working on an Egyptian themed kit quite some time ago but unfortunately never finished it. I've got some spare time available at the moment though; perfect opportunity to start working on this again.

I won't be making a full custom story, just the assets and a small demo map for showing them off in game.

Once the kit is completed I'll post the files and the demo map in this thread. You will be free to use them for whatever you'd like, also no need to credit me or anything.

Here are some WIP screenshots:

Spoiler below!

Please feel free to post some feedback on this stuff. Do take into account that it's not final quality yet, the statue for instance is still a simple block-out. I do also have to say that I don't want to spend much more time on this kit, so I won't be implementing any really extensive changes or additions.