Built-in: Fog

[Richter Belmont]

Here a kinda easy to use, but yet limited function of the game. The ability to add a fog inside your gaming world.
Fog script can be write down in any scene.bs type file (room, cloth, toy...)
If writte down in an add-on toy scene.bs for example, the fog will appear with the toy and get removed with the toy.
Fog affect the whole room, no matter what kind of scene.bs you used.
This is why I said limited: you cannot set the fog to a specific place in the room, it will always be set to the whole room.

[To see links please log-in or register here]

This is what the code example give in-game

First of all, you need a TFog that will be connected to a SFog and a parent TNode.
Using the :local_1 as the parent TNode should do the trick.

Code:

TFog :local_theFog . {[/color]
[color=#000000]TNode.SNode SFog :local_StheFog;[/color]
[color=#000000]TNode.Parent TTransform :local_1;[/color]
[color=#000000]Object.Name "theFog";[/color]
[color=#000000]};[/color]
[color=#000000]SFog :local_StheFog . {[/color]
[color=#000000]SFog.Type SFog.TypeEnum.Exponential;[/color]
[color=#000000]SFog.Density F32(0.2);[/color]
[color=#000000]SFog.Color Vector3f( 0.3, 0.8, 0.5 );[/color]
[color=#000000]Object.Name "StheFog";[/color]
[color=#000000]};

As you can see, the SFog contain all the parameter of the fog.
Let review them.

SFog.DistanceType SFog.DistanceTypeEnum
This parameter can take two value: .ScreenSpace or .EyeSpace
I don't manage to see what this parameter do.
You can let the game use the default value by not writing the parameter in your SFog

SFog.Type SFog.TypeEnum
This parameter can take three value: .Linear , .Exponential or .Exponential2
This parameter control how the fog un/blured thing in the room.
Manual = .Linear + SFog.NearFar
Auto = .Exponential or .Exponential2
I don't see any difference between .Exponential and .Exponential2
Auto(.Exponential) do a nice job and make manual(.Linear) looking pointless

SFog.Density
This parameter use a F32() as value and control how opaque the fog will appear to be.
Using a high value (1 is alreay high) it will be really difficult to see trought the fog and vice versa.

SFog.Color
This parameter use a Vector3f() as value and set the color of the fog.
Color seem to be different in Playpen.

SFog.NearFar
This parameter use a Vector2f() as value and control the distance from the view at which the thing in the room get un/blured by the fog.
This parameter only work with SFog.Type SFog.TypeEnum.Linear