Frictional Game Wiki

<h1>Player Tool</h1> <div class="level1"> <p> <b>Helper function prefix:</b> Player_ </p> <p> This module handles the player's use of <code>Prop_Tool</code> objects that they pick up, including maintaining an inventory list, deciding if a tool is equipped (shown in the player's hands) and whether tools can be used on particular entities or areas. In SOMA, this covers things like the Omnitool or scan chips. </p> <p> The Player Tool module uses <code>Prop_Tool</code> objects. </p> </div> <h2>Prop_Tool Level Editor Properties</h2> <div class="level2"> </div> <h3>PickupCallback</h3> <div class="level3"> <p> Called when the tool is picked up from in level by the player. </p> </div> <h3>UseCallback</h3> <div class="level3"> <p> Called when the tool is used on another object </p> </div> <h3>CanBeUsedCallback</h3> <div class="level3"> <p> Called to check if the tool can currently be used </p> </div> <h3>DropCallback</h3> <div class="level3"> <p> Called when the tools is dropped (Use returns false) </p> </div> <h3>AutoHideAfterPickup</h3> <div class="level3"> <p> Hide when the tool is picked up. </p> </div> <h3>HighlightActive</h3> <div class="level3"> <p> Is the tool highlighted in level when you're nearby? </p> </div> <h2>Prop_Tool Model Editor Properties</h2> <div class="level2"> </div> <h3>HudObjectEntity</h3> <div class="level3"> <p> Which entity to use when held in the player's hands, equipped? </p> </div> <h3>InventoryTextEntry</h3> <div class="level3"> <p> Text to show on the inventory screen </p> </div> <h3>InventoryIcon</h3> <div class="level3"> <p> Icon to show on the inventory screen </p> </div> <h3>HandAnimationSuffix</h3> <div class="level3"> <p> Suffix to add to player hand animation names, for custom anims for this tool. </p> </div> <h3>IsHeavy</h3> <div class="level3"> <p> Will player be unable to jump / use terminals etc. when carrying this object? </p> </div> <h3>CustomUseIcon</h3> <div class="level3"> <p> Icon to show when the tool is held over another object. </p> </div> <h2>Important Functions</h2> <div class="level2"> </div> <h3>Player_PlayCustomToolAnimation</h3> <div class="level3"> <p> Plays an animation on the currently displayed tool's entity. </p> </div> <h3>Player_ToolIsInInventory</h3> <div class="level3"> <p> Checks to see if the player has picked up a tool with this name. </p> </div> <h3>Player_EquipTool</h3> <div class="level3"> <p> The player holds up the tool in his hand if it's in the inventory. </p> </div> <h3>Player_UnequipTool</h3> <div class="level3"> <p> The player puts away the tool in his hand. </p> </div> <h3>Player_RemoveTool</h3> <div class="level3"> <p> The tool is removed from the player's inventory </p> </div> <h3>Player_RemoveAllTools</h3> <div class="level3"> <p> All tools are removed from the player's inventory </p> </div>