mirror of
https://github.com/LoneWolfHT/grenades.git
synced 2024-11-21 22:33:45 +01:00
Fix markdown
This commit is contained in:
parent
3e85df539a
commit
94f311b43f
42
api.md
42
api.md
@ -1,24 +1,26 @@
|
||||
#Grenades API
|
||||
# Grenades API
|
||||
|
||||
Still WIP. Please suggest new features here: https://forum.minetest.net/viewtopic.php?f=9&t=21466
|
||||
|
||||
##API
|
||||
## API
|
||||
|
||||
grenades.register_grenade("name", { -- Name of the grenade (Like 'smoke' or 'flashbang')
|
||||
description = "", -- A short description of the grenade.
|
||||
image = "", -- The name of the grenade's texture
|
||||
on_explode = function(pos, name)
|
||||
-- This function is called when the grenade 'explodes'
|
||||
-- <pos> the place the grenade 'exploded' at
|
||||
-- <name> the name of the player that threw the grenade
|
||||
end,
|
||||
placeable = false, -- Optional, default is false
|
||||
clock = 3, -- Optional, controls how long until grenade detonates. Default is 3
|
||||
particle = { -- Adds particles in the grenade's trail
|
||||
image = "grenades_smoke.png", -- The particle's image
|
||||
life = 1, -- How long (seconds) it takes for the particle to disappear
|
||||
size = 4, -- Size of the particle
|
||||
glow = 0, -- Brightens the texture in darkness
|
||||
interval = 5, -- How long it takes before a particle can be added
|
||||
}
|
||||
})
|
||||
```lua
|
||||
grenades.register_grenade("name", { -- Name of the grenade (Like 'smoke' or 'flashbang')
|
||||
description = "", -- A short description of the grenade.
|
||||
image = "", -- The name of the grenade's texture
|
||||
on_explode = function(pos, name)
|
||||
-- This function is called when the grenade 'explodes'
|
||||
-- <pos> the place the grenade 'exploded' at
|
||||
-- <name> the name of the player that threw the grenade
|
||||
end,
|
||||
placeable = false, -- Optional, default is false
|
||||
clock = 3, -- Optional, controls how long until grenade detonates. Default is 3
|
||||
particle = { -- Adds particles in the grenade's trail
|
||||
image = "grenades_smoke.png", -- The particle's image
|
||||
life = 1, -- How long (seconds) it takes for the particle to disappear
|
||||
size = 4, -- Size of the particle
|
||||
glow = 0, -- Brightens the texture in darkness
|
||||
interval = 5, -- How long it takes before a particle can be added
|
||||
}
|
||||
})
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user