Below is a template for a ToolClass script, used for controlling handheld tools.
Tool = class()
-- Serverside Callbacks
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#oncreatefunction Tool.server_onCreate( self )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#onrefreshfunction Tool.server_onRefresh( self )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#onfixedupdatefunction Tool.server_onFixedUpdate( self, dt )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#ondestroyfunction Tool.server_onDestroy( self )
end
-- Clientside Callbacks
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#oncreatefunction Tool.client_onCreate( self )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#onrefreshfunction Tool.client_onRefresh( self )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#onfixedupdatefunction Tool.client_onFixedUpdate( self, dt )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#onupdatefunction Tool.client_onUpdate( self, dt )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#onequipfunction Tool.client_onEquip( self, animate )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#onunequipfunction Tool.client_onUnequip( self, animate )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#onequippedupdatefunction Tool.client_onEquippedUpdate( self, primaryState, secondaryState, forceBuild )
return true, trueend
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#ontogglefunction Tool.client_onToggle( self, backwards )
return trueend
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#onreloadfunction Tool.client_onReload( self )
return trueend
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#canequipfunction Tool.client_canEquip( self )
return trueend
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/ToolClass#equipwhileseatedfunction Tool.client_equipWhileSeated( self )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#onclientdataupdatefunction Tool.client_onClientDataUpdate( self, data, channel )
end
-- https://scrapmechanictools.com/lua/Game-Script-Environment/Classes/CommonCallbacks#ondestroyfunction Tool.client_onDestroy( self )
end