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

Base class for all 3DRadSpace objects. More...

Inheritance diagram for _3DRadSpaceDll.GameObject:
_3DRadSpaceDll.Camera _3DRadSpaceDll.Camera2D _3DRadSpaceDll.EventOnKey _3DRadSpaceDll.EventOnLocation _3DRadSpaceDll.EventOnValue _3DRadSpaceDll.ExitFade _3DRadSpaceDll.Fog _3DRadSpaceDll.Script _3DRadSpaceDll.Skinmesh _3DRadSpaceDll.Skybox _3DRadSpaceDll.SkyColor _3DRadSpaceDll.SoundEffect _3DRadSpaceDll.Sprite _3DRadSpaceDll.TextPrint _3DRadSpaceDll.Timer

Public Member Functions

 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...
 

Static Public Member Functions

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

Vector3 Position
 Object position More...
 
Vector3 Rotation
 Rotation in a Euler angles system. More...
 
List< int > SelectedObjects
 Used for editor. More...
 

Properties

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...
 

Events

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

Base class for all 3DRadSpace objects.

Constructor & Destructor Documentation

◆ GameObject()

_3DRadSpaceDll.GameObject.GameObject ( )

Default constructor.

Member Function Documentation

◆ Disable()

void _3DRadSpaceDll.GameObject.Disable ( )

Disables object.

◆ Draw()

virtual void _3DRadSpaceDll.GameObject.Draw ( SpriteBatch  spriteBatch,
Matrix?  view,
Matrix?  projection 
)
virtual

◆ EditorDraw()

virtual void _3DRadSpaceDll.GameObject.EditorDraw ( SpriteBatch  spriteBatch,
Matrix?  view,
Matrix?  projection 
)
virtual

◆ Enable()

void _3DRadSpaceDll.GameObject.Enable ( )

Enables object.

◆ Equals()

override bool _3DRadSpaceDll.GameObject.Equals ( object  obj)

Determines whether the specified object is equal to the current object.

Parameters
objThe object to compare with the current object.
Returns

◆ GetHashCode()

override int _3DRadSpaceDll.GameObject.GetHashCode ( )

Returns the hash code calculated from a string representing the data inside the object.

Returns
Some hash code

◆ Hide()

void _3DRadSpaceDll.GameObject.Hide ( )

Hides the object.

◆ Load()

virtual void _3DRadSpaceDll.GameObject.Load ( ContentManager  content)
virtual

◆ operator bool()

static implicit _3DRadSpaceDll.GameObject.operator bool ( GameObject  o)
static

Checks if the object exists. Same as GameObject != null.

Parameters
oGameObject to check.

◆ operator!=()

static bool _3DRadSpaceDll.GameObject.operator!= ( GameObject  a,
GameObject  b 
)
static

The opposite of the equality operator.

Parameters
aLeft instance.
bRight instance.
Returns
A boolean value representine the inequality of the two given instances.

◆ operator==()

static bool _3DRadSpaceDll.GameObject.operator== ( GameObject  a,
GameObject  b 
)
static

Checks if two GameObjects are equal.

Parameters
aLeft instance.
bRight instance.
Returns
A boolean value representing the equality value.

◆ RunOnce()

void _3DRadSpaceDll.GameObject.RunOnce ( )

Runs the object one Update loop. If used on a active object it will be stopped.

◆ Show()

void _3DRadSpaceDll.GameObject.Show ( )

Shows the object.

◆ Toggle()

void _3DRadSpaceDll.GameObject.Toggle ( )

Switches object on/off state.

◆ ToString()

override string _3DRadSpaceDll.GameObject.ToString ( )

Returns the object's name

Returns
the object's name

◆ Trigger()

virtual void _3DRadSpaceDll.GameObject.Trigger ( )
virtual

This is specific to objects like ExitFade, NetServer,etc

Reimplemented in _3DRadSpaceDll.SoundEffect, and _3DRadSpaceDll.ExitFade.

◆ Update()

virtual void _3DRadSpaceDll.GameObject.Update ( MouseState  mouse,
KeyboardState  keyboard,
GameTime  time 
)
virtual

Member Data Documentation

◆ Position

Vector3 _3DRadSpaceDll.GameObject.Position

Object position

◆ Rotation

Vector3 _3DRadSpaceDll.GameObject.Rotation

Rotation in a Euler angles system.

◆ SelectedObjects

List<int> _3DRadSpaceDll.GameObject.SelectedObjects

Used for editor.

Property Documentation

◆ Behiavours

List<ObjectBehiavour> _3DRadSpaceDll.GameObject.Behiavours
getset

Relation with other objects

◆ Enabled

bool _3DRadSpaceDll.GameObject.Enabled
getset

Checks if object is enabled.

◆ Hidden

bool _3DRadSpaceDll.GameObject.Hidden
getset

Checks if object is being drawn.

◆ Name

string _3DRadSpaceDll.GameObject.Name
getset

Object Name. Used as a string identifier.

◆ Resource

string _3DRadSpaceDll.GameObject.Resource
getset

Resource file

◆ RotationQuaternion

Quaternion _3DRadSpaceDll.GameObject.RotationQuaternion
get

Rotation in a Quaterion system.

◆ Tag

object _3DRadSpaceDll.GameObject.Tag
getset

Tag object.

Event Documentation

◆ OnDraw

onDraw _3DRadSpaceDll.GameObject.OnDraw

Called when object is being drawn on frame.

◆ OnObjectLoad

onObjectLoad _3DRadSpaceDll.GameObject.OnObjectLoad

Called when a object resource is being loaded.

◆ OnRemoval

onObjectDestroy _3DRadSpaceDll.GameObject.OnRemoval

Called when object is being deleted.

◆ OnUpdate

onUpdate _3DRadSpaceDll.GameObject.OnUpdate

Called when object is being updated on the update logic loop.