Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_Environment.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 
71 class env
72 {
73 public:
74 
91  void setTOD_Time( float time );
92 
110  float getTOD_Time();
111 
127  void setTOD_TimeMultiplier( float speedMulti );
128 
144  float getTOD_TimeMultiplier();
145 
163  void setTOD_Enabled( int enabled );
164 
180  int getTOD_Enabled();
181 
198  void loadTODFile( string filename );
199 
217  void setTOD_VolCloudsEnabled( int enabled );
218 
235 
252  void setTOD_LightEnabled( int enabled );
253 
269  int getTOD_LightEnabled();
270 
287  void setTOD_DiffuseStrength( float strength );
288 
304  float getTOD_DiffuseStrength();
305 
322  void setTOD_SpecularStrength( float strength );
323 
339  float getTOD_SpecularStrength();
340 
341 };
float getTOD_DiffuseStrength()
Get the current Lighting diffuse strength.
void setTOD_SpecularStrength(float strength)
Set the Specular Lighting Strength.
int getTOD_LightEnabled()
Get whether the Sky Lighting is enabled or not.
void setTOD_LightEnabled(int enabled)
Set whether Sky Lighting is enabled.
int getTOD_VolCloudsEnabled()
Get whether the Volume Clouds are enabled.
void setTOD_Enabled(int enabled)
Set whether the TOD Sky Movement is enabled or not.
void setTOD_TimeMultiplier(float speedMulti)
Set the time speed multiplier.
void setTOD_DiffuseStrength(float strength)
Set the Diffuse Lighting Strength.
Definition: LUA_API_Time.h:27
Definition: LUA_API_Environment.h:71
void setTOD_Time(float time)
Set the time of day in a 24 hr clock.
void setTOD_VolCloudsEnabled(int enabled)
Set whether Volume Clouds are enabled. This can be used as a performance throttling.
float getTOD_TimeMultiplier()
Get the time of day speed multiplier.
void loadTODFile(string filename)
Load a sky configuration file during runtime.
int getTOD_Enabled()
Get whether the TOD Sky Movement is enabled.
float getTOD_SpecularStrength()
Get the current Lighting specular strength.
float getTOD_Time()
Get the time of day in a 24 hr clock mode.