https://wiki.frictionalgames.com/page?action=history&feed=atom&title=Hpl3%3AGame%3Ascripting%3Auser_modules%3Aplayer_tool 2026-05-15T09:40:49Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=Hpl3:Game:scripting:user_modules:player_tool&diff=575&oldid=prev 2020-07-09T13:43:55Z

<p>Upload from wiki</p> <p><b>New page</b></p><div>= Player Tool =<br /> '''Helper function prefix:''' Player_<br /> <br /> This module handles the player's use of ''Prop_Tool'' 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.<br /> <br /> The Player Tool module uses ''Prop_Tool'' objects.<br /> <br /> ==== Prop_Tool Level Editor Properties ===<br /> === PickupCallback ===<br /> <br /> Called when the tool is picked up from in level by the player.<br /> === UseCallback ===<br /> <br /> Called when the tool is used on another object<br /> === CanBeUsedCallback ===<br /> <br /> Called to check if the tool can currently be used<br /> === DropCallback ===<br /> <br /> Called when the tools is dropped (Use returns false)<br /> === AutoHideAfterPickup ===<br /> <br /> Hide when the tool is picked up.<br /> === HighlightActive ===<br /> <br /> Is the tool highlighted in level when you're nearby?<br /> <br /> ==== Prop_Tool Model Editor Properties ===<br /> === HudObjectEntity ===<br /> <br /> Which entity to use when held in the player's hands, equipped?<br /> === InventoryTextEntry ===<br /> <br /> Text to show on the inventory screen<br /> === InventoryIcon ===<br /> <br /> Icon to show on the inventory screen<br /> === HandAnimationSuffix ===<br /> <br /> Suffix to add to player hand animation names, for custom anims for this tool.<br /> === IsHeavy ===<br /> <br /> Will player be unable to jump / use terminals etc. when carrying this object?<br /> === CustomUseIcon ===<br /> <br /> Icon to show when the tool is held over another object.<br /> <br /> == Important Functions ==<br /> <br /> === Player_PlayCustomToolAnimation ===<br /> Plays an animation on the currently displayed tool's entity.<br /> === Player_ToolIsInInventory ===<br /> Checks to see if the player has picked up a tool with this name.<br /> === Player_EquipTool ===<br /> The player holds up the tool in his hand if it's in the inventory.<br /> === Player_UnequipTool ===<br /> The player puts away the tool in his hand.<br /> === Player_RemoveTool ===<br /> The tool is removed from the player's inventory<br /> === Player_RemoveAllTools ===<br /> All tools are removed from the player's inventory</div>

Maintenance script