https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FScripting_Api%2FProp
HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Prop - Revision history
2026-05-02T06:43:39Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Prop&diff=6170&oldid=prev
Abion47: Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte..."
2020-11-15T23:06:56Z
<p>Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Summary==<br />
{{CodeDocSummaryTop}}<br />
{{CodeDocSummaryItem|void|[[#Prop_AddAttachedProp|Prop_AddAttachedProp]]([[../../tString|tString]] &in asPropName, [[../../tString|tString]] &in asAttachName, [[../../tString|tString]] &in asAttachFile, [[../../cVector3f|cVector3f]] &in avPosOffset, [[../../cVector3f|cVector3f]] &in avRotOffset)|Attaches a prop mesh (any other data is skipped) to a Prop}}<br />
{{CodeDocSummaryItem|void|[[#Prop_AddHealth|Prop_AddHealth]](const [[../../tString|tString]] &in asPropName, float afHealth)|Adds health to a prop}}<br />
{{CodeDocSummaryItem|void|[[#Prop_AlignRotation|Prop_AlignRotation]](const [[../../tString|tString]] &in asName, const [[../../tString|tString]] &in asTargetEntity, float afAcceleration, float afMaxSpeed, float afSlowDownDist, bool abResetSpeed, const [[../../tString|tString]] &in asCallback <nowiki>=</nowiki> "", const [[../../tString|tString]] &in asOffsetEntity <nowiki>=</nowiki> "")|Aligns the rotation of the specified prop to the current rotation of the target entity}}<br />
{{CodeDocSummaryItem|void|[[#Prop_ClearVelocity|Prop_ClearVelocity]](const [[../../tString|tString]] &in asPropName)|Clear out all velocity on a prop}}<br />
{{CodeDocSummaryItem|bool|[[#Prop_Clone|Prop_Clone]](const [[../../tString|tString]] &in asSourceProp, const [[../../tString|tString]] &in asDestName, float afScale <nowiki>=</nowiki> 1.0f)|Returns a new copy of asSourceProp as a new prop called asDestName, with asSourceProp's properties}}<br />
{{CodeDocSummaryItem|bool|[[#Prop_CopyScriptProperties|Prop_CopyScriptProperties]](const [[../../tString|tString]] &in asSourceProp, const [[../../tString|tString]] &in asDestProp)|Copies all script properties (but not position, bodies and so on) from one prop to another existing prop of the same type}}<br />
{{CodeDocSummaryItem|bool|[[#Prop_CopyState|Prop_CopyState]](const [[../../tString|tString]] &in asSourceProp, const [[../../tString|tString]] &in asDestProp)|Copies all properties etc}}<br />
{{CodeDocSummaryItem|void|[[#Prop_DisableCollisionUntilOutsidePlayer|Prop_DisableCollisionUntilOutsidePlayer]](const [[../../tString|tString]] &in asPropName)|}}<br />
{{CodeDocSummaryItem|float|[[#Prop_GetHealth|Prop_GetHealth]](const [[../../tString|tString]] &in asPropName)|Gets the health of a prop}}<br />
{{CodeDocSummaryItem|void|[[#Prop_MoveLinearTo|Prop_MoveLinearTo]](const [[../../tString|tString]] &in asName, const [[../../tString|tString]] &in asTargetEntity, float afAcceleration, float afMaxSpeed, float afSlowDownDist, bool abResetSpeed, const [[../../tString|tString]] &in asCallback <nowiki>=</nowiki> "")|Moves the specified prop to the current position of the target entity}}<br />
{{CodeDocSummaryItem|void|[[#Prop_RemoveAttachedProp|Prop_RemoveAttachedProp]]([[../../tString|tString]] &in asPropName, [[../../tString|tString]] &in asAttachName)|Removes an attached prop from a prop}}<br />
{{CodeDocSummaryItem|void|[[#Prop_RotateToSpeed|Prop_RotateToSpeed]](const [[../../tString|tString]] &in asPropName, float afAcc, float afGoalSpeed, const [[../../cVector3f|cVector3f]] &in avAxis, bool abResetSpeed, const [[../../tString|tString]] &in asOffsetEntity)|Rotates a prop to a target speed}}<br />
{{CodeDocSummaryItem|void|[[#Prop_RotateToSpeed|Prop_RotateToSpeed]](const [[../../tString|tString]] &in asPropName, float afAcc, float afGoalSpeed, bool abResetSpeed, const [[../../tString|tString]] &in asOffsetEntity)|Rotates a prop to a target speed}}<br />
{{CodeDocSummaryItem|void|[[#Prop_SetActiveAndFade|Prop_SetActiveAndFade]](const [[../../tString|tString]] &in asPropName, bool abActive, float afFadeTime)|Activates or deactivates a entity and fades the mesh in or out}}<br />
{{CodeDocSummaryItem|void|[[#Prop_SetAllowMapTransfer|Prop_SetAllowMapTransfer]](const [[../../tString|tString]] &in asPropName, bool abX)|Sets if a prop should be transfered}}<br />
{{CodeDocSummaryItem|void|[[#Prop_SetHealth|Prop_SetHealth]](const [[../../tString|tString]] &in asPropName, float afHealth)|Sets the health of a prop}}<br />
{{CodeDocSummaryItem|void|[[#Prop_SetStaticPhysics|Prop_SetStaticPhysics]](const [[../../tString|tString]] &in asPropName, bool abX)|Sets the physics of the object to static or dynamic}}<br />
{{CodeDocSummaryItem|void|[[#Prop_StopMovement|Prop_StopMovement]](const [[../../tString|tString]] &in asPropName)|Stops the static movement of a prop}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Function Detail==<br />
{{CodeDocDetailTop|Prop_AddAttachedProp}}<br />
<syntaxhighlight lang="c++">void Prop_AddAttachedProp(tString &in asPropName,<br />
tString &in asAttachName,<br />
tString &in asAttachFile,<br />
cVector3f &in avPosOffset,<br />
cVector3f &in avRotOffset)</syntaxhighlight><br />
{{CodeDocDetailBody|Attaches a prop mesh (any other data is skipped) to a Prop}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asAttachName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asAttachFile|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|avPosOffset|[[../../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|avRotOffset|[[../../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_AddHealth}}<br />
<syntaxhighlight lang="c++">void Prop_AddHealth(const tString &in asPropName,<br />
float afHealth)</syntaxhighlight><br />
{{CodeDocDetailBody|Adds health to a prop.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afHealth|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_AlignRotation}}<br />
<syntaxhighlight lang="c++">void Prop_AlignRotation(const tString &in asName,<br />
const tString &in asTargetEntity,<br />
float afAcceleration,<br />
float afMaxSpeed,<br />
float afSlowDownDist,<br />
bool abResetSpeed,<br />
const tString &in asCallback = "",<br />
const tString &in asOffsetEntity = "")</syntaxhighlight><br />
{{CodeDocDetailBody|Aligns the rotation of the specified prop to the current rotation of the target entity.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asTargetEntity|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afAcceleration|float|}}<br />
{{CodeDocDetailParam|afMaxSpeed|float|}}<br />
{{CodeDocDetailParam|afSlowDownDist|float|}}<br />
{{CodeDocDetailParam|abResetSpeed|bool|}}<br />
{{CodeDocDetailParam|asCallback|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asOffsetEntity|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_ClearVelocity}}<br />
<syntaxhighlight lang="c++">void Prop_ClearVelocity(const tString &in asPropName)</syntaxhighlight><br />
{{CodeDocDetailBody|Clear out all velocity on a prop.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_Clone}}<br />
<syntaxhighlight lang="c++">bool Prop_Clone(const tString &in asSourceProp,<br />
const tString &in asDestName,<br />
float afScale = 1.0f)</syntaxhighlight><br />
{{CodeDocDetailBody|Returns a new copy of asSourceProp as a new prop called asDestName, with asSourceProp's properties.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asSourceProp|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asDestName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afScale|float|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_CopyScriptProperties}}<br />
<syntaxhighlight lang="c++">bool Prop_CopyScriptProperties(const tString &in asSourceProp,<br />
const tString &in asDestProp)</syntaxhighlight><br />
{{CodeDocDetailBody|Copies all script properties (but not position, bodies and so on) from one prop to another existing prop of the same type.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asSourceProp|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asDestProp|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_CopyState}}<br />
<syntaxhighlight lang="c++">bool Prop_CopyState(const tString &in asSourceProp,<br />
const tString &in asDestProp)</syntaxhighlight><br />
{{CodeDocDetailBody|Copies all properties etc. from one prop to another existing prop of the same type.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asSourceProp|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asDestProp|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_DisableCollisionUntilOutsidePlayer}}<br />
<syntaxhighlight lang="c++">void Prop_DisableCollisionUntilOutsidePlayer(const tString &in asPropName)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_GetHealth}}<br />
<syntaxhighlight lang="c++">float Prop_GetHealth(const tString &in asPropName)</syntaxhighlight><br />
{{CodeDocDetailBody|Gets the health of a prop.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|float|float, the health of the specified prop.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_MoveLinearTo}}<br />
<syntaxhighlight lang="c++">void Prop_MoveLinearTo(const tString &in asName,<br />
const tString &in asTargetEntity,<br />
float afAcceleration,<br />
float afMaxSpeed,<br />
float afSlowDownDist,<br />
bool abResetSpeed,<br />
const tString &in asCallback = "")</syntaxhighlight><br />
{{CodeDocDetailBody|Moves the specified prop to the current position of the target entity.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asTargetEntity|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afAcceleration|float|}}<br />
{{CodeDocDetailParam|afMaxSpeed|float|}}<br />
{{CodeDocDetailParam|afSlowDownDist|float|}}<br />
{{CodeDocDetailParam|abResetSpeed|bool|}}<br />
{{CodeDocDetailParam|asCallback|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_RemoveAttachedProp}}<br />
<syntaxhighlight lang="c++">void Prop_RemoveAttachedProp(tString &in asPropName,<br />
tString &in asAttachName)</syntaxhighlight><br />
{{CodeDocDetailBody|Removes an attached prop from a prop}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asAttachName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_RotateToSpeed}}<br />
<syntaxhighlight lang="c++">void Prop_RotateToSpeed(const tString &in asPropName,<br />
float afAcc,<br />
float afGoalSpeed,<br />
const cVector3f &in avAxis,<br />
bool abResetSpeed,<br />
const tString &in asOffsetEntity)</syntaxhighlight><br />
{{CodeDocDetailBody|Rotates a prop to a target speed.<br/>the prop will rotate around its own axis.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afAcc|float|}}<br />
{{CodeDocDetailParam|afGoalSpeed|float|}}<br />
{{CodeDocDetailParam|avAxis|[[../../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|abResetSpeed|bool|}}<br />
{{CodeDocDetailParam|asOffsetEntity|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_RotateToSpeed}}<br />
<syntaxhighlight lang="c++">void Prop_RotateToSpeed(const tString &in asPropName,<br />
float afAcc,<br />
float afGoalSpeed,<br />
bool abResetSpeed,<br />
const tString &in asOffsetEntity)</syntaxhighlight><br />
{{CodeDocDetailBody|Rotates a prop to a target speed. Using the up vector of offset entity as axis.<br/>If left as , the prop will rotate around its own up axis.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afAcc|float|}}<br />
{{CodeDocDetailParam|afGoalSpeed|float|}}<br />
{{CodeDocDetailParam|abResetSpeed|bool|}}<br />
{{CodeDocDetailParam|asOffsetEntity|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_SetActiveAndFade}}<br />
<syntaxhighlight lang="c++">void Prop_SetActiveAndFade(const tString &in asPropName,<br />
bool abActive,<br />
float afFadeTime)</syntaxhighlight><br />
{{CodeDocDetailBody|Activates or deactivates a entity and fades the mesh in or out.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|abActive|bool|}}<br />
{{CodeDocDetailParam|afFadeTime|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_SetAllowMapTransfer}}<br />
<syntaxhighlight lang="c++">void Prop_SetAllowMapTransfer(const tString &in asPropName,<br />
bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets if a prop should be transfered}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_SetHealth}}<br />
<syntaxhighlight lang="c++">void Prop_SetHealth(const tString &in asPropName,<br />
float afHealth)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the health of a prop}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afHealth|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_SetStaticPhysics}}<br />
<syntaxhighlight lang="c++">void Prop_SetStaticPhysics(const tString &in asPropName,<br />
bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the physics of the object to static or dynamic}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Prop_StopMovement}}<br />
<syntaxhighlight lang="c++">void Prop_StopMovement(const tString &in asPropName)</syntaxhighlight><br />
{{CodeDocDetailBody|Stops the static movement of a prop.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPropName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}</div>
Abion47