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

**Mudbill** · 10-26-2018, 11:44 PM

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.

[Image: 4O75ijm.png]

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: (Select All)

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: (Select All)
float Math_RandFloat(float afMin, float afMax)
= RandFloat

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

PHP Code: (Select All)
float Math_Sin(float afX)
= MathSin

PHP Code: (Select All)
float Math_Cos(float afX)
= MathCos

PHP Code: (Select All)
float Math_Tan(float afX)
= MathTan

PHP Code: (Select All)
float Math_Asin(float afX)
= MathAsin

PHP Code: (Select All)
float Math_Acos(float afX)
= MathAcos

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

PHP Code: (Select All)
float Math_Sqrt(float afX)
= MathSqrt

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

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

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

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

PHP Code: (Select All)
float Math_Abs(float afX)
= MathAbs

String

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

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

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

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

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

Debug

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

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

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

PHP Code: (Select All)
bool Debug_GetEnabled()
= ScriptDebugOn

Script

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ParticleSystem

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

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

Code: (Select All)
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: (Select All)
void ParticleSystem_Destroy(string& asName)
= DestroyParticleSystem

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

PHP Code: (Select All)
void ParticleSystem_StopPlayerSpawnPS()
= StopPlayerSpawnPS

Sound

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

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

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

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

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

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

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

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

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

PHP Code: (Select All)
void Sound_StopAllEffectVoices(float afFadeOutTime)
= StopAllEffectVoices

PHP Code: (Select All)
bool Sound_GetEffectVoiceActive()
= GetEffectVoiceActive

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

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

Light

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

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

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

Game

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

PHP Code: (Select All)
void Game_StartDemoEnd()
= StartDemoEnd

PHP Code: (Select All)
void Game_AutoSave()
= AutoSave

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

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

PHP Code: (Select All)
void Game_DisableDeathStartSound()
= DisableDeathStartSound

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

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

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

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

PHP Code: (Select All)
void Game_CreateDataCache()
= CreateDataCache

PHP Code: (Select All)
void Game_DestroyDataCache()
= DestroyDataCache

Map

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

= CheckPoint

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

PHP Code: (Select All)
void Map_ClearSavedMaps()
= ClearSavedMaps

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

PHP Code: (Select All)
void Map_SetSkyboxActive(bool abActive)
= SetSkyBoxActive

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

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

PHP Code: (Select All)
void Map_SetFogActive(bool abActive)
= SetFogActive

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

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

Timer

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

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

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

Effect

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

PHP Code: (Select All)
void Effect_FadeIn(float afTime)
= FadeIn

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

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

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

PHP Code: (Select All)
void Effect_SetRadialBlurStartDist(float afStartDist)
= SetRadialBlurStartDist

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

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

PHP Code: (Select All)
bool Effect_GetFlashbackIsActive()
= GetFlashbackIsActive

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

PHP Code: (Select All)
void Effect_SetInDarknessEffectsActive(bool abX)
= SetInDarknessEffectsActive

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

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

PHP Code: (Select All)
void Effect_StartRandomInsanityEvent()
= StartRandomInsanityEvent

PHP Code: (Select All)
void Effect_StopCurrentInsanityEvent()
= StopCurrentInsanityEvent

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

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

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

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

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

Player

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

PHP Code: (Select All)
void Player_ChangeStateToNormal()
= ChangePlayerStateToNormal

PHP Code: (Select All)
void Player_SetCrouching(bool abCrouch)
= SetPlayerCrouching

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

PHP Code: (Select All)
void Player_ShowCrossHairIcons(bool abX)
= ShowPlayerCrossHairIcons

PHP Code: (Select All)
void Player_SetSanity(float afSanity)
= SetPlayerSanity

PHP Code: (Select All)
void Player_AddSanity(float afSanity)
= AddPlayerSanity

PHP Code: (Select All)
float Player_GetSanity()
= GetPlayerSanity

PHP Code: (Select All)
void Player_SetHealth(float afHealth)
= SetPlayerHealth

PHP Code: (Select All)
void Player_AddPlayerHealth(float afHealth)
= AddPlayerHealth

PHP Code: (Select All)
float Player_GetHealth()
= GetPlayerHealth

PHP Code: (Select All)
void Player_SetLampOil(float afOil)
= SetPlayerLampOil

PHP Code: (Select All)
void Player_AddLampOil(float afOil)
= AddPlayerLampOil

PHP Code: (Select All)
float Player_GetLampOil()
= GetPlayerLampOil

PHP Code: (Select All)
float Player_GetSpeed()
= GetPlayerSpeed

PHP Code: (Select All)
float Player_GetYSpeed()
= GetPlayerYSpeed

PHP Code: (Select All)
void Player_SetSanityDrainDisabled(bool abX)
= SetSanityDrainDisabled

PHP Code: (Select All)
void Player_GiveSanityBoost()
= GiveSanityBoost

PHP Code: (Select All)
void Player_GiveSanityBoostSmall()
= GiveSanityBoostSmall

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

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

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

PHP Code: (Select All)
void Player_StopLookAt()
= StopPlayerLookAt

PHP Code: (Select All)
void Player_SetMoveSpeedMul(float afMul)
= SetPlayerMoveSpeedMul

PHP Code: (Select All)
void Player_SetRunSpeedMul(float afMul)
= SetPlayerRunSpeedMul

PHP Code: (Select All)
void Player_SetLookSpeedMul(float afMul)
= SetPlayerLookSpeedMul

PHP Code: (Select All)
void Player_SetJumpForceMul(float afMul)
= SetPlayerJumpForceMul

PHP Code: (Select All)
void Player_SetJumpDisabled(bool abX)
= SetPlayerJumpDisabled

PHP Code: (Select All)
void Player_SetCrouchDisabled(bool abX)
= SetPlayerCrouchDisabled

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

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

PHP Code: (Select All)
void Player_SetLanternDisabled(bool abX)
= SetLanternDisabled

PHP Code: (Select All)
bool Player_GetLanternActive()
= GetLanternActive

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

PHP Code: (Select All)
void Player_MoveForward(float afAmount)
= MovePlayerForward

PHP Code: (Select All)
void Player_SetFallDamageDisabled(bool abX)
= SetPlayerFallDamageDisabled

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

PHP Code: (Select All)
float Player_GetPosX()
= GetPlayerPosX

PHP Code: (Select All)
float Player_GetPosY()
= GetPlayerPosY

PHP Code: (Select All)
float Player_GetPosZ()
= GetPlayerPosZ

Journal

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

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

PHP Code: (Select All)
void Journal_ReturnOpen(bool abOpenJournal)
= ReturnOpenJournal

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

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

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

PHP Code: (Select All)
void Journal_SetNumberOfQuestsInMap(int alNumberOfQuests)
= SetNumberOfQuestsInMap

Inventory

Quote:
PHP Code: (Select All)
void Inventory_Exit()
= ExitInventory

PHP Code: (Select All)
void Inventory_SetDisabled(bool abX)
= SetInventoryDisabled

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

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

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

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

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

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

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

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

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

Entity

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

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

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

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

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

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

= ReplaceEntity

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= RotatePropToSpeed

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

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

= AttachPropToProp

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

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

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

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

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

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

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

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

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

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

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

= InteractConnectPropWithRope

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

= InteractConnectPropWithMoveObject

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

= ConnectEntities

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

PHP Code: (Select All)
void Entity_SetAllowStickyAreaAttachment(bool abX)
= SetAllowStickyAreaAttachment

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

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

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

MoveObject

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

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

= SetMoveObjectStateExt

Lamp

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

SwingDoor

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

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

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

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

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

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

LevelDoor

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

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

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

Wheel

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

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

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

Lever

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

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

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

Button

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

MultiSlider

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

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

NPC

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

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

Enemy

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

**HappyMatt12345** · 12-02-2018, 09:33 AM

Looking to use this, the only thing I want to do is add a few custom ones (following the same name convention of course) for your SetLocalVarBool, GetLocalVarBool, SetGlobalVarBool, etc. functions that I am also using.

**Mudbill** · 12-03-2018, 05:21 PM

This by default only includes the main functions, but custom ones are no problem of course Tongue

This would be the code to add for those functions:

PHP Code: (Select All)

void Script_SetLocalVarBool(string& asName, bool abVal) {
    SetLocalVarInt(asName, abVal ? 1 : 0);
}
 
bool Script_GetLocalVarBool(string& asName) {
    return GetLocalVarInt(asName) != 0;
}

void Script_SetGlobalVarBool(string& asName, bool abVal) {
    SetGlobalVarInt(asName, abVal ? 1 : 0);
}
 
bool Script_GetGlobalVarBool(string& asName) {
    return GetGlobalVarInt(asName) != 0;
}