teknomunk
/
MineClone2
forked from VoxeLibre/VoxeLibre
1
0
Fork 0
Code Pull Requests Activity

Correct documentation per review

This commit is contained in:
teknomunk 2024-08-06 18:56:00 -05:00
parent 93a6dc3626
commit 814ea20148
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
mods/CORE/vl_legacy/API.md
View File

@ -1,15 +1,15 @@
# Legacy Code Support Functions # Legacy Code Support Functions
## vl\_legacy.deprecated(description, replacement) ## `vl_legacy.deprecated(description, replacement)`
Creates a wrapper than logs calls to deprecated function. Creates a wrapper that logs calls to deprecated function.
Arguments: Arguments:
* `description`: The text logged when the deprecated function is called. * `description`: The text logged when the deprecated function is called.
* `replacement`: The function that should be called instead. This is invoked passing * `replacement`: The function that should be called instead. This is invoked passing
along the parameters exactly as provided. along the parameters exactly as provided.
## vl\_legacy.register\_item\_conversion ## `vl_legacy.register_item_conversion`
Allows automatic conversion of items. Allows automatic conversion of items.

4
mods/ENTITIES/mcl_minecarts/API.md
View File

@ -46,7 +46,7 @@ Where to attach passengers to the minecarts.
`mcl_minecarts.HORIZONTAL_CURVES_RULES` `mcl_minecarts.HORIZONTAL_CURVES_RULES`
`mcl_minecarts.HORIZONTAL_STANDARD_RULES` `mcl_minecarts.HORIZONTAL_STANDARD_RULES`
Rail connection rules. Each rule is an table with the following indexes: Rail connection rules. Each rule is a table with the following indexes:
1. `node_name_suffix` - The suffix added to a node's `_mcl_minecarts.base_name` to 1. `node_name_suffix` - The suffix added to a node's `_mcl_minecarts.base_name` to
get the name of the node to use for this connection. get the name of the node to use for this connection.
@ -167,7 +167,7 @@ Force a minecart to start moving in the opposite direction of its current direct
Returns a valid cart movement direction that has the smallest angle between it and `direction_vector`. Returns a valid cart movement direction that has the smallest angle between it and `direction_vector`.
`mcl_minecarts:update_cart_orientation(cart)` `mcl_minecarts.update_cart_orientation(cart)`
Updates the rotation of a cart entity to match the cart's data. Updates the rotation of a cart entity to match the cart's data.