Grimrock

Code: Select all

		-- I have added the default values for all the SkyComponent fields here.
		{
			class = "Sky",
			ambientIntensity = 1,
			-- farClip is two things.
			-- First, farClip is the scale of the sky model. I don't call
			-- it a skybox because it isn't a box, it's about 75% of a sphere.
			-- The model follows the party on the world x and z axes, but not
			-- on the y axis; it is possible for the party to ascend above
			-- the sky model or descend below it.
			-- The default sky model is about 75% of a sphere with a
			-- diameter of exactly 1, so the farClip will be equal to the
			-- diameter.
			--
			-- Second, farClip is the distance from the camera at which
			-- the sky will draw. Anything that is not within this distance
			-- from the party - even if the party has ascended above the sky
			-- model like I mentioned - is occluded, and replaced with the sky
			-- if the sky is "behind" it, or replaced with black otherwise.
			-- This means farClip can be used as a maximum draw distance.
			-- You may be wondering why I bother to distinguish between
			-- these two effects at all; aren't they the same as long as
			-- the party is inside the sky model, which they always should be?
			-- Well, no, and you'll find out why soon.
			--
			-- It's fine to change it dynamically. Remember, a 32x32 level
			-- is 96x96 meters.
			farClip = 130,

			-- There are four fog modes. "linear_lit" is the default, and
			-- it only extends to a distance of about 129.884297 meters;
			-- anything further from the camera than that will be
			-- unaffected by the fog. When this happens to a normal model,
			-- it's very ugly, but it has the advantage of allowing
			-- fog to be used without affecting the sky at all, so long as
			-- the sky's farClip is above approximately 129.884297.
			-- (Remember, farClip is "the distance from the party at
			-- which the sky will draw"; fog will *always* affect every
			-- pixel of the sky the same way, because the sky is always
			-- treated as being that distance away, even if parts of the
			-- sky model are actually closer or further away).
			--
			-- "dense" is the other one that most people know about, used
			-- in places like Keelbreach Bog.
			--
			-- But there are two more, overlooked fog modes:
			-- "linear" is the same as "linear_lit" except it continues
			-- beyond range 128.
			--
			-- "exp" seems to completely ignore fog range unless it's set
			-- to turn fog off entirely, and instead forces a very short
			-- range of about 3 meters; it is not useful as far as I can
			-- tell.
			--
			-- No matter which mode you choose, fog does not perform
			-- occlusion. Try farClip for that.
			fogMode = "linear_lit",

			-- The first number is the distance in meters from the camera
			-- at which the fog begins; the second is the distance at
			-- which it reaches 100% opacity.
			-- If you set both numbers to the same value, e.g.
			-- fogRange = {1,1}, then fog will be disabled entirely
			-- (unless the fog mode is "exp").
			-- Works backwards! If you set it to {8,1} then a halo of fog
			-- will follow the camera, with anything closer than 1 meter
			-- being fully fogged up, and anything more than 8 meters away
			-- being completely clear.
			-- Fine to change dynamically.
			fogRange = {5, 300},

			-- tonemapSaturation multiplies the saturation of all pixels
			-- in the 3d world (GUI elements are not affected). A value
			-- of 1 is the default, and doesn't change colours at all
			-- (since 1 is the multipilicative identity).
			--
			-- A value of 0 will make the world completely greyscale.
			--
			-- A sufficiently high value (such as math.huge) will make the
			-- world render with only the 3 primary colours at maximum
			-- brightness (and their combinations).
			--
			-- Negative values work, and will have the effect of inverting
			-- the hues on screen (because that's what happens when you
			-- multiply saturation by a negative number). So a
			-- tonemapSaturation of -1 would invert the
			-- hues of the pixels without changing their saturation.
			-- A tonemapSaturation of -2 looks just like an inverted
			-- version of tonemapSaturation = 2.
			--
			-- Finally, a tonemapSaturation of NaN will turn the entire 3D
			-- view completely black. This is probably not safe, and is
			-- completely useless in any case. If you want to turn the
			-- screen black, you should put a CameraComponent inside a
			-- black cube and point it outside the level; that way you
			-- will render as little as possible, no point in rendering
			-- things that won't be seen.
			--
			-- Fine to change dynamically.
			tonemapSaturation = 1,

			-- Okay, now one last thing. For both fog and farClip, the
			-- distance used isn't the real, visual, Euclidean distance
			-- between two points. Instead, it seems to be the Chebyshev
			-- distance, with the axes adopting the camera's rotation.
			--
			-- Along with fog, this is why I emphasized that farClip does
			-- two things.
			--
			-- Suppose the sky has a farClip of 100. Imagine a cube that
			-- is centered on the camera. Also imagine that this cube has
			-- the same rotation as the camera. Each edge of the cube is
			-- 200 meters long (radius of 100 meters).
			--
			-- Anything inside this cube is drawn. Anything outside this
			-- cube is replaced with the sky (or black).
			--
			-- So the sky's farClip actually has a different shape than
			-- the sky's spherical model. Fog is the same. This shape
			-- is also different from what you're used to seeing in the
			-- rest of the game and life in general (Euclidean distance).
			-- If you make your fog too noticeable (short range and/or
			-- extreme colours) the player will likely see the square
			-- shape of it.
		},
		{ -- LensFlareComponent has no fields or methods available. It just
		-- handles the lens flare that appears when you look at the sun.
		-- This is the only component on skies that is optional; you can
		-- completely remove it from the definition and the sky will still
		-- work without complaining (and, obviously, it will not have a lens
		-- flare).
			class = "LensFlare",
		},
	},
	placement = "floor",
	editorIcon = 100,
	reflectionMode = "always", -- This won't actually matter unless you added
		-- extra visual components. Skies ALWAYS get reflected.
}