Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_Scene.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2016 http://www.aurasoft.co.uk
8 // |
9 // | Skyline Game Engine Lua API Documentation
10 // |
11 // | This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
12 // | This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other
13 // | person outside of the Skyline Game Engine development team.
14 // |
15 // | Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2016
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
26 class scene
27 {
28 public:
29 
44  void setFogEnabled(int state);
45 
57  int isFogEnabled();
58 
78  void setFogMode(int mode);
79 
92  void setFogDensity(float density);
93 
108  void setFogLinearStart(float linearStart);
109 
124  void setFogLinearEnd(float linearEnd);
125 
141  void setFogColour(float r, float g, float b);
142 
153  float3 getFogColour();
154 
167  int getFogMode();
168 
180  float getFogDensity();
181 
193  float getFogLinearStart();
194 
206  float getFogLinearEnd();
207 
208 };
float getFogLinearStart()
Get the Linear start (close to camera) of the fog if using a linear fog mode. If using Exp or Exp2...
void setFogColour(float r, float g, float b)
Set the colour of the fog in the scene using an RGB param set.
void setFogLinearEnd(float linearEnd)
Set the linear End range (Far from camera) for a linear Fog mode.
void setFogEnabled(int state)
Enable or Disable the use of fog in a scene through lua.
float3 getFogColour()
Return the colour of the current fog in the scene.
void setFogMode(int mode)
Set the fog mode to use. Choices are Linear, Exp or Exp2.
float getFogDensity()
Get the density of the fog if using an Exp or Exp2 fog mode. If using Linear, then please use getFogL...
float getFogLinearEnd()
Get the Linear end (far from camera) of the fog if using a linear fog mode. If using Exp or Exp2...
void setFogLinearStart(float linearStart)
Set the linear Starting range (close to camera) for a linear Fog mode.
int getFogMode()
Get the current fog mode whether it is Linear, Exp or Exp2.
void setFogDensity(float density)
Control the density of the fog for an Exp or Exp2 fog mode.
Definition: LUA_API_States.h:28
Definition: LUA_API_Scene.h:26
int isFogEnabled()
Return whether fog is enabled. 1 = enabled, 0 = disabled.