minetest-mods
/
throwing
mirror of https://github.com/minetest-mods/throwing.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix typos and update README 

* Mynetest has been renamed Eurythmia,
* "Developed" contains only one P,
* Bugs using `throw_itself` are to be expected as this field is mostly untested,
* And the last paragraph is of questionable grammatical correctness.
This commit is contained in:
upsilon 2018-08-13 10:37:45 +02:00
parent 90b85cdb2e
commit 154566bd72
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,6 +1,6 @@
# Throwing
## Developped by the Mynetest team
## Developed by the Eurythmia team
This mod is an API for registering throwing and throwable things.
@ -46,6 +46,8 @@ Definition: definition table, containing:
* throw_itself (optional): whether the bow should throw itself instead of the arrow next to it in the inventory.
If present, allow_shot is ignored.
Default is false.
*Warning*: this field is not known to be currently used by a mod. If you encounter bugs using it, please open
an issue!
* cooldown: bow cooldown. Default is setting throwing.bow_cooldown
* function spawn_arrow_entity(position, arrow, player): defaults to throwing.spawn_arrow_entity
* sound: sound to be played when the bow is used
@ -108,6 +110,6 @@ throwing.register_arrow("arrow", {
})
```
If the item to throw is an arrow registered using `minetest.register_arrow`, the entity used will be the registered entity.
Otherwise, if its definition contains a `throwing_entity` field, this field will be used as the entity name if it is a string, otherwise it will be called as a function(pos, player) that has to make the object to spawn and to return the corresponding ObjectRef.
If the item is neither an arrow nor has any `throwing_entity` field, the corresponding `__builtin:item` will be used.
If the item to throw is an arrow registered using `throwing.register_arrow`, the entity used will be the entity automatically registered by this function.
Otherwise, if its definition contains a `throwing_entity` field, this field will be used as the entity name if it is a string, otherwise it will be called as a `function(pos, player)` that has to spawn the object and return the corresponding ObjectRef.
If the item is neither an arrow nor has a `throwing_entity` field, the corresponding `__builtin:item` will be used.