sixam/climate_api
1
0
Fork 0
mirror of https://github.com/t-affeldt/climate_api.git synced 2025-07-24 16:15:04 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tweak world cycle, add documentation

Browse source
This commit is contained in:
Till Affeldt 2020-04-26 18:11:38 +02:00
parent bff54bfb74
commit 9e0ed0c256
10 changed files with 114 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

9
ca_effects/hud_overlay.lua
View file

@ -1,3 +1,12 @@
--[[
# HUD Overlay Effect
Use this effect to display a fullscreen image as part of a player's HUD.
Expects a table as the parameter containing the following values:
- ``file <string>``: The name (including file ending) if the image to be displayed
- ``z_index <number>`` (optional): The z_index to forward to player.hud_add. Defaults to 1
- ``color_correction <bool>`` (optional): Whether the image should automatically darken based on current light. Defaults to false.
]]
if not climate_mod.settings.hud_overlay then return end
local EFFECT_NAME = "climate_api:hud_overlay"