Skip to content

Commit

Permalink
Standardize hook docs with function docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thecraftianman committed Aug 30, 2024
1 parent 167e45c commit 15251bb
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions lua/acf/hooks/hooks_missiles_sv.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ local Hooks = ACF.Utilities.Hooks

Hooks.Add("ACF_Missiles_Server", function(Gamemode)
--- Called after a missile is fired.
-- @param Entity The missile entity that was launched.
--- @param Entity entity The missile entity that was launched.
function Gamemode:ACF_OnMissileLaunched()
end

--- Called when a missile attempts to create an explosion.
-- @param Entity The affected missile.
-- @param Data The bullet data of the affected missile.
-- @return True if the missile can explode, false otherwise.
--- @param Entity entity The affected missile.
--- @param Data table The bullet data of the affected missile.
--- @return boolean # True if the missile can explode, false otherwise.
function Gamemode:ACF_MissileCanExplode()
return true
end

--- Called when a missile plays its sound if the ACF Sound Extension Project by looterz is installed.
-- This is a legacy hook from ACF-2 and may be removed at any time.
-- @param Entity The missile entity to play sound on.
-- @param Sound The sound to play.
--- This is a legacy hook from ACF-2 and may be removed at any time.
--- @param Entity entity The missile entity to play sound on.
--- @param Sound string The sound to play.
function Gamemode:ACF_SOUND_MISSILE()
end
end)

0 comments on commit 15251bb

Please sign in to comment.