Wuzzy/minetest_doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Require API programmer to check category before adding alias

Browse Source
This commit is contained in:
Wuzzy 2016-11-17 18:43:29 +01:00
parent 1cd11eadbb
commit 66cb0a4a8c
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
API.md
View File

@ -335,6 +335,7 @@ Always `nil`.
Adds a single alias for an entry. When an entry has an alias, supplying the Adds a single alias for an entry. When an entry has an alias, supplying the
alias to a function which demands an `entry_id` will work as if the original alias to a function which demands an `entry_id` will work as if the original
`entry_id` has been supplied. Aliases are true within one category only. `entry_id` has been supplied. Aliases are true within one category only.
When using this function, you must make sure the category already exists.
#### Parameters #### Parameters
* `category_id`: Category identifier of the category of the entry in question * `category_id`: Category identifier of the category of the entry in question
@ -348,6 +349,7 @@ Always `nil`.
### `doc.add_entry_aliases(category_id, entry_id, aliases)` ### `doc.add_entry_aliases(category_id, entry_id, aliases)`
Adds an arbitrary amount of aliases for an entry at once. Apart from that, this Adds an arbitrary amount of aliases for an entry at once. Apart from that, this
function has the same effect as `doc.add_entry_alias`. function has the same effect as `doc.add_entry_alias`.
When using this function, you must make sure the category already exists.
#### Parameters #### Parameters
* `category_id`: Category identifier of the category of the entry in question * `category_id`: Category identifier of the category of the entry in question