https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Tool&feed=atom&action=historyHPL3/Amnesia: Rebirth/Scripting/Scripting Api/Tool - Revision history2024-03-29T15:45:35ZRevision history for this page on the wikiMediaWiki 1.34.2https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Tool&diff=6178&oldid=prevAbion47: 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:08:00Z<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|[[../../tString|tString]]|[[#Tool_GetHandAnimationSuffix|Tool_GetHandAnimationSuffix]](const [[../../tString|tString]] &in asName)|Returns the hand animation prefix specified for the tool}}<br />
{{CodeDocSummaryItem|void|[[#Tool_PickUp|Tool_PickUp]](const [[../../tString|tString]] &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]] &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]] &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 />
<syntaxhighlight lang="c++">tString Tool_GetHandAnimationSuffix(const tString &in asName)</syntaxhighlight><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 />
<syntaxhighlight lang="c++">void Tool_PickUp(const tString &in asName,<br />
bool abEquipTool,<br />
bool abCallback)</syntaxhighlight><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 />
<syntaxhighlight lang="c++">void Tool_SetAutoHideAfterPickup(const tString &in asName,<br />
bool abX)</syntaxhighlight><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 />
<syntaxhighlight lang="c++">void Tool_SetHighlightActive(const tString &in asName,<br />
bool abX)</syntaxhighlight><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