https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FScripting_Api%2FTool 2026-05-01T20:27:00Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Tool&diff=6178&oldid=prev 2020-11-15T23:08:00Z

<p>Created page with &quot;{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...&quot;</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|[[../../tString|tString]]|[[#Tool_GetHandAnimationSuffix|Tool_GetHandAnimationSuffix]](const [[../../tString|tString]] &amp;in asName)|Returns the hand animation prefix specified for the tool}}<br /> {{CodeDocSummaryItem|void|[[#Tool_PickUp|Tool_PickUp]](const [[../../tString|tString]] &amp;in asName, bool abEquipTool, bool abCallback)|Adds the specified tool to the player's inventory}}<br /> {{CodeDocSummaryItem|void|[[#Tool_SetAutoHideAfterPickup|Tool_SetAutoHideAfterPickup]](const [[../../tString|tString]] &amp;in asName, bool abX)|Sets if a tool should be hidden automatically after getting picked up and being displayed for a brief moment}}<br /> {{CodeDocSummaryItem|void|[[#Tool_SetHighlightActive|Tool_SetHighlightActive]](const [[../../tString|tString]] &amp;in asName, bool abX)|Sets if a tool should have the highlight effect when looked at}}<br /> {{CodeDocSummaryBottom}}<br /> <br /> ==Function Detail==<br /> {{CodeDocDetailTop|Tool_GetHandAnimationSuffix}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;tString Tool_GetHandAnimationSuffix(const tString &amp;in asName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Returns the hand animation prefix specified for the tool.}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailReturn|tString|tString, the tool's hand animation prefix.}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Tool_PickUp}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Tool_PickUp(const tString &amp;in asName,<br /> bool abEquipTool,<br /> bool abCallback)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Adds the specified tool to the player's inventory. Similar to calling the entity interact on the tool entity, but with more control.}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abEquipTool|bool|}}<br /> {{CodeDocDetailParam|abCallback|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Tool_SetAutoHideAfterPickup}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Tool_SetAutoHideAfterPickup(const tString &amp;in asName,<br /> bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets if a tool should be hidden automatically after getting picked up and being displayed for a brief moment}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Tool_SetHighlightActive}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Tool_SetHighlightActive(const tString &amp;in asName,<br /> bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets if a tool should have the highlight effect when looked at.}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}</div>

Abion47