200 lines
7.1 KiB
Markdown
200 lines
7.1 KiB
Markdown
# **Documentation of 1042 for development and modding**
|
|
|
|
This is documentation for development and modding for the game `1042` on the *Luanti* game engine.
|
|
|
|
|
|
|
|
|
|
# Core interface
|
|
|
|
## `core_1042` is the namespace for all core_1042 functions
|
|
- `core_1042.eat(itemstack, user, food_value, p_chance)` This removes one item from itemstack from the player `user` and adds `value` to `user`'s HP, `p_chance` is chance of taking damage of 2 times `food_value` while eating item.
|
|
- `core_1042.read_file(filename)` Read a file and return its contense as a string. Returns `nil` if no data is read.
|
|
- `core_1042.get_pointed_thing(player)` Gets player pointed thing, in form of raycast.
|
|
- `core_1042.set(key, value)` Sets a game stored value to key.
|
|
- `core_1042.get(value)` Gets a game stored value from key.
|
|
- `core_1042.info` Game info table.
|
|
- `core_1042.rand` Core random a `PcgRandom(math.random(1, 2048))` object. This can be used by anything.
|
|
- `core_1042.register_loot(def)` Register loot as defined by `Loot table`
|
|
- `core_1042.get_loot()` Returns a random `ItemStack` from the loot that is registered.
|
|
|
|
|
|
## Tables
|
|
|
|
### `Loot table`
|
|
|
|
```lua
|
|
{
|
|
name = <name>,
|
|
max_count = <maxcount>
|
|
}
|
|
```
|
|
|
|
|
|
|
|
|
|
# Groups
|
|
|
|
- `breakable_by_hand` Player can break these items without tools. value is for break-time `{[1] = 0.25, [2] = 0.5, [3] = 1, [4] = 2, [5] = 3, [6] = 4}`
|
|
- `stone` Stone nodes. Value is for tools like pick, for break-time. `{[1] = 1, [2] = 2, [3] = 3, [4] = 4, [5] = 5, [6] = 6}`
|
|
- `leafy` Leafy nodes.
|
|
- `plant` Plant (Biomass) nodes.
|
|
- `wood` Wood nodes. Value is for tools like axe, for break-time. `{[1] = 1, [2] = 2, [3] = 3, [4] = 4, [5] = 5, [6] = 6}`
|
|
- `cools` Nodes that cool hot nodes.
|
|
- `burning` For burning/hot nodes.
|
|
- `burns` Nodes that can catch on fire. Value is chance from `1` to `<group value>` chance of burning.
|
|
- `molten` Uses `_1042_cools_to` for node.
|
|
- `melts` Uses `_1042_melts_to` for node.
|
|
- `cooks` Uses `_1042_cooks_to` for node. Value is chance from 1 to `<group value>` of cooking per check.
|
|
|
|
|
|
|
|
|
|
|
|
# Node definition fields
|
|
|
|
There are a few new node definition fields for ABMs and such:
|
|
|
|
- `_1042_cools_to = <node>` Node cools to given node.
|
|
- `_1042_melts_to = <node>` Node melts to given node.
|
|
- `_1042_cooks_to = <node>` Node cooks to given node.
|
|
|
|
|
|
## Callbacks
|
|
- `_1042_on_use = function(itemstack, player, pointed_thing)` on_use but for aux1. Uses `raycast` object.
|
|
|
|
|
|
|
|
|
|
# APIs
|
|
|
|
There are a few APIs built into the game, and more planned for the beta release.
|
|
|
|
|
|
## Achievement API `achievements_1042`
|
|
|
|
`achievements_1042` is the mod that contains the API for achievements, along with some core achievements.
|
|
|
|
|
|
## Functions
|
|
|
|
- `achievements_1042.achieve(player, achievement_name)` Returns `nil` if the achievement does not exist, `false` if the player already has it, and `true` if the achievement is shown to the player.
|
|
- `achievements_1042.register_achievement(achievement_name, achievement_definition)` Register an achievement, returns `false` if already registered, `true` otherwise.
|
|
|
|
|
|
## Exposed tables
|
|
- `achievements_1042.achievements` All registered achievements.
|
|
|
|
|
|
## Achievement definition
|
|
```lua
|
|
{
|
|
achievement = core.colorize("#ffffff", "First life"),
|
|
colour = "#00ffaa"
|
|
}
|
|
```
|
|
|
|
|
|
## Core achievements
|
|
|
|
- `first_life` This is the achievement for first spawn of a player.
|
|
- `smelter` This is the achievement for first ingot broken.
|
|
|
|
|
|
|
|
|
|
# Weather API
|
|
|
|
Weathers are registered by appending to the end of `weather.weathers` with a weather definition. Tempetures across the map vary in range of ~-30 to ~30, though they may be slightly above or below these.
|
|
|
|
|
|
## Weather API
|
|
|
|
The weather API is avalible in both the asynch mapgen enviorment and main via import from file (as done in mapgen.)
|
|
|
|
-`function weather.get_temp_map(x, z)` Get a temp map starting at `x, z`. The map is a mapblock, thus 80x80.
|
|
-`function weather.get_temp(pos, temp_map)` Get temp from temp map with coords on that temp map.
|
|
-`function weather.get_temp_single(pos)` Get temp at a position, this is faster than using the other two for single coords.
|
|
- `weather.rand` A `PcgRandom` object.
|
|
|
|
|
|
## Weathers API
|
|
|
|
Present if `weather.is_loaded` is set to `true`.
|
|
|
|
### Functions and talbes
|
|
|
|
- `weather.players_weather` A table of player weather data, index with player name.
|
|
- `weather.weathers` All registered weather definitions.
|
|
- `weather.default_on_change(player, name, players_weather)` Default `on_change` call back, called between every change to try to clean up.
|
|
- `weather.register_weather(def)` Regsiter a `Weather Definition`. Note: If a on_change sets a sound it must store the handle for it in `players_weather.sound_handle` before returning. This should not modify sky paramiters other than using: `player:set_sun()`, `player:set_clouds()`, `player:set_sky()` and `player:set_lighting()`. For more info see `on_change` usage down further.
|
|
- `weather.get_weather_at_pos(pos)` Return the index to weather in `weather.weathers` that matches the current global weather and local weather.
|
|
- `weather.weather_hight` Hight of spawning for weather particles.
|
|
|
|
## Weather Definition
|
|
|
|
```lua
|
|
{
|
|
name = "Light snow",
|
|
conditions = {
|
|
temp = {
|
|
max = 0
|
|
}
|
|
},
|
|
on_change = function(player, players_weather) end, -- Code can only modify things that will be restored in weather.default_on_change or sounds.
|
|
on_step = function(player), -- Code that is run once per weather step (1 second)
|
|
on_end = function(player, name, players_weather), -- Code run at end defaults to weather.default_on_change if not used, otherwise you must undo ALL changes made in on_change
|
|
particlespawner =
|
|
{
|
|
amount = 500,
|
|
time = 1,
|
|
|
|
collisiondetection = true,
|
|
object_collision = true,
|
|
collision_removal = true,
|
|
|
|
vel = {
|
|
min = vector.new(-2, -1, -2),
|
|
max = vector.new(2, -4, 2),
|
|
bias = 0
|
|
},
|
|
|
|
size = {
|
|
min = 0.5,
|
|
max = 1
|
|
},
|
|
|
|
exptime = {
|
|
min = 6,
|
|
max = 8
|
|
},
|
|
|
|
bounce = {
|
|
min = 0,
|
|
max = 0.3
|
|
},
|
|
|
|
glow = 8,
|
|
|
|
texture = "1042_plain_node.png^[colorize:#ddddff:144"
|
|
}
|
|
}
|
|
```
|
|
|
|
|
|
### `on_change(player, name, players_weather)`
|
|
|
|
This call back is called once per weather change after the defaults are reset. This function can set sounds but the sounds must be stored in `players_weather.sound_handle`. Anything changed here, excluding sounds, must be reverted with `on_end(player, name, players_weather)` or if not present the defaults of `weather.default_on_change`.
|
|
|
|
### `the_weather.on_end(player, name, players_weather)`
|
|
|
|
If `the_weather.on_end(player, name, players_weather)` is defined then all things changed in `on_change` MUST be reverted, this does not include the sound set with `players_weather.sound_handle` but all other things, as the default handler will not be run.
|
|
|
|
|
|
|
|
|
|
# Development
|
|
|
|
## Things to fix
|
|
|
|
- Things in code/content, that are known to need fixing soon can be found by greping for `#fixme`. |