pandorabox-io/skybox

Skybox management mod

Register your skyboxes in a central place

Api

-- register a skybox
skybox.register(skybox_def)

• skybox_def (table)
  • name id/name of the skybox, has to be unique
    • miny (optional if you use match) minimum matching y-height
    • maxy (optional if you use match) maximum y-height
    • sky_type (optional) string to pass onto player:set_sky()
    • sky_color (optional) color to pass onto player:set_sky()
    • always_day (optional) day_night_ratio ratio is overriden to 1.0 if this is true
    • textures (optional) 6 textures of a texured skybox
    • clouds (optional) clouds to pass onto player:set_clouds()
    • match (optional if you use miny and maxy) custom matcher, see Custom matcher below
    • priority (optional) higher priority skyboxes get applied first

Examples

Dark caves

skybox.register({
	name = "earth_cave",
	miny = -32000,
	maxy = -50,
	sky_type = "plain",
	sky_color = {r=0, g=0, b=0}
})

Space

• auto-granted fly-priv

skybox.register({
	-- https://github.com/Ezhh/other_worlds/blob/master/skybox.lua
	name = "deepspace",
	miny = 6001,
	maxy = 10999,
	always_day = true,
	textures = {
		"sky_pos_z.png",
		"sky_neg_z.png^[transformR180",
		"sky_neg_y.png^[transformR270",
		"sky_pos_y.png^[transformR270",
		"sky_pos_x.png^[transformR270",
		"sky_neg_x.png^[transformR90"
	}
})

Custom matcher

Custom non-height dependent matcher for players -> skybox

skybox.register({
	name = "green zone",
	sky_type = "plain",
	sky_color = {r=0, g=255, b=0},
	match = function(player, pos)
		-- beware: this function gets called every second for every player!
		return pos.x > 20000 and pos.z > 20000
	end
})

Override the default skybox

The function skybox.set_defaults can be called with new default values:

-- set the default values (everything is optional)
skybox.set_defaults({
	sky = {...}, -- sky definition
	moon = {...},
	stars = {...},
	clouds = {...},
	sun = {...}
})