3DRadSpace  v1.0.0a
Scripting documentation
_3DRadSpaceDll.Fog Class Reference

More...

Inheritance diagram for _3DRadSpaceDll.Fog:
_3DRadSpaceDll.GameObject

Public Member Functions

 Fog (string name, bool enabled, Color color=default, float start=50, float end=500)
 Fog class constructor. More...
 
 Fog ()
 Empty Fog object constructor. More...
 
- Public Member Functions inherited from _3DRadSpaceDll.GameObject
 GameObject ()
 Default constructor. More...
 
void Enable ()
 Enables object. More...
 
void Disable ()
 Disables object. More...
 
void Toggle ()
 Switches object on/off state. More...
 
void Show ()
 Shows the object. More...
 
void Hide ()
 Hides the object. More...
 
virtual void Load (ContentManager content)
 Loads the resource(s). More...
 
virtual void Draw (SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Unloads the resource. More...
 
virtual void EditorDraw (SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Object draw code for the 3DRadSpace editor More...
 
virtual void Update (MouseState mouse, KeyboardState keyboard, GameTime time)
 Object update logic More...
 
virtual void Trigger ()
 This is specific to objects like ExitFade, NetServer,etc More...
 
override bool Equals (object obj)
 Determines whether the specified object is equal to the current object. More...
 
override int GetHashCode ()
 Returns the hash code calculated from a string representing the data inside the object. More...
 
override string ToString ()
 Returns the object's name More...
 
void RunOnce ()
 Runs the object one Update loop. If used on a active object it will be stopped. More...
 

Properties

Vector3 FogColor [get, set]
 Fog Color. Implemented from IEffectFog. More...
 
bool FogEnabled [get, set]
 Actually sets this.Enabled. Implemented from IEffectFog. More...
 
float FogEnd [get, set]
 Fog end distance. More...
 
float FogStart [get, set]
 Fog start distance. More...
 
- Properties inherited from _3DRadSpaceDll.GameObject
string Name [get, set]
 Object Name. Used as a string identifier. More...
 
object Tag [get, set]
 Tag object. More...
 
bool Enabled [get, set]
 Checks if object is enabled. More...
 
bool Hidden [get, set]
 Checks if object is being drawn. More...
 
List< ObjectBehiavourBehiavours [get, set]
 Relation with other objects More...
 
Quaternion RotationQuaternion [get]
 Rotation in a Quaterion system. More...
 
string Resource [get, set]
 Resource file More...
 

Additional Inherited Members

- Static Public Member Functions inherited from _3DRadSpaceDll.GameObject
static implicit operator bool (GameObject o)
 Checks if the object exists. Same as GameObject != null. More...
 
static bool operator== (GameObject a, GameObject b)
 Checks if two GameObjects are equal. More...
 
static bool operator!= (GameObject a, GameObject b)
 The opposite of the equality operator. More...
 
- Public Attributes inherited from _3DRadSpaceDll.GameObject
Vector3 Position
 Object position More...
 
Vector3 Rotation
 Rotation in a Euler angles system. More...
 
List< int > SelectedObjects
 Used for editor. More...
 
- Events inherited from _3DRadSpaceDll.GameObject
onDraw OnDraw
 Called when object is being drawn on frame. More...
 
onUpdate OnUpdate
 Called when object is being updated on the update logic loop. More...
 
onObjectDestroy OnRemoval
 Called when object is being deleted. More...
 
onObjectLoad OnObjectLoad
 Called when a object resource is being loaded. More...
 

Detailed Description

Fog class. Allows Fog effects on Skinmeshes.

Notice the missing Draw,EditorDraw and Update functions. The fields and properties are only used.

Constructor & Destructor Documentation

◆ Fog() [1/2]

_3DRadSpaceDll.Fog.Fog ( string  name,
bool  enabled,
Color  color = default,
float  start = 50,
float  end = 500 
)

Fog class constructor.

Parameters
nameObject name
enabledIs the fog effect allowed?
color
start
end

◆ Fog() [2/2]

_3DRadSpaceDll.Fog.Fog ( )

Empty Fog object constructor.

Property Documentation

◆ FogColor

Vector3 _3DRadSpaceDll.Fog.FogColor
getset

Fog Color. Implemented from IEffectFog.

◆ FogEnabled

bool _3DRadSpaceDll.Fog.FogEnabled
getset

Actually sets this.Enabled. Implemented from IEffectFog.

◆ FogEnd

float _3DRadSpaceDll.Fog.FogEnd
getset

Fog end distance.

◆ FogStart

float _3DRadSpaceDll.Fog.FogStart
getset

Fog start distance.