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

Allows raising events when a object is within the specified bounding object. More...

Inheritance diagram for _3DRadSpaceDll.EventOnLocation:
_3DRadSpaceDll.GameObject

Public Member Functions

 EventOnLocation ()
 Empty EventOnLocation constructor. More...
 
 EventOnLocation (string name, bool enabled, bool visible_editor, BoundingBox box)
 Creates a EventOnLocation based on the given

See also
Microsoft.Xna.Framework.BoundingBox
More...
 
 EventOnLocation (string name, bool enabled, bool visible_editor, BoundingSphere sphere)
 Creates a EventOnLocation based on the given

See also
Microsoft.Xna.Framework.BoundingSphere
More...
 
 EventOnLocation (string name, bool enabled, bool visible_editor, Plane plane)
 Creates a EventOnLocation based on the given

See also
Microsoft.Xna.Framework.Plane
More...
 
override void Update (MouseState mouse, KeyboardState keyboard, GameTime time)
 
override void EditorDraw (SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Marks the bounding area in the editor. More...
 
override void Load (ContentManager content)
 Loads the sphere and box markings. 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 Draw (SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Unloads the resource. 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...
 

Public Attributes

BoundingObject BoundingType
 Sets the bounding type for the detection. More...
 
BoundingSphere BoundingSphere
 Bounding sphere. More...
 
BoundingBox BoundingBox
 Bounding box. More...
 
Plane BoundingPlane
 Plane made up of More...
 
List< int > ColidingObjects
 A list containing the objects that are being detected by the box. More...
 
bool VisibleInEditor
 If yes, shows a green box marking the bounding zone. More...
 
new List< OpcodeEvent.OpCodeCallBehiavours
 The event defined in the editor. 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...
 

Static Public Attributes

static Model Cube
 A green transparent cube used to mark the bounding cube in the editor. More...
 
static Model Sphere
 A green trransparent sphere used to mark the bounding sphere in the editor. More...
 

Events

OnBoundingObjectEnter OnObjectInside
 Raised when a object is inside the bounding object. 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...
 

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

Detailed Description

Allows raising events when a object is within the specified bounding object.

Constructor & Destructor Documentation

◆ EventOnLocation() [1/4]

_3DRadSpaceDll.EventOnLocation.EventOnLocation ( )

Empty EventOnLocation constructor.

◆ EventOnLocation() [2/4]

_3DRadSpaceDll.EventOnLocation.EventOnLocation ( string  name,
bool  enabled,
bool  visible_editor,
BoundingBox  box 
)

Creates a EventOnLocation based on the given

See also
Microsoft.Xna.Framework.BoundingBox

Parameters
nameName of the object
enabledChecks if the collisoin events will be raised.
visible_editorChecks if the object is visible in the editor
boxBounding box.

◆ EventOnLocation() [3/4]

_3DRadSpaceDll.EventOnLocation.EventOnLocation ( string  name,
bool  enabled,
bool  visible_editor,
BoundingSphere  sphere 
)

Creates a EventOnLocation based on the given

See also
Microsoft.Xna.Framework.BoundingSphere

Parameters
nameName of the object
enabledChecks if the collisoin events will be raised.
visible_editorChecks if the object is visible in the editor
sphereBounding sphere.

◆ EventOnLocation() [4/4]

_3DRadSpaceDll.EventOnLocation.EventOnLocation ( string  name,
bool  enabled,
bool  visible_editor,
Plane  plane 
)

Creates a EventOnLocation based on the given

See also
Microsoft.Xna.Framework.Plane

Parameters
nameName of the object
enabledChecks if the collisoin events will be raised.
visible_editorChecks if the object is visible in the editor
planeBounding plane

Member Function Documentation

◆ EditorDraw()

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

Marks the bounding area in the editor.

Parameters
spriteBatchNot used.
viewView Matrix.
projectionProjection Matrix.

Reimplemented from _3DRadSpaceDll.GameObject.

◆ Load()

override void _3DRadSpaceDll.EventOnLocation.Load ( ContentManager  content)
virtual

Loads the sphere and box markings.

Parameters
content

Reimplemented from _3DRadSpaceDll.GameObject.

◆ Update()

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

Parameters
mouse
keyboard
time

Reimplemented from _3DRadSpaceDll.GameObject.

Member Data Documentation

◆ Behiavours

new List<OpcodeEvent.OpCodeCall> _3DRadSpaceDll.EventOnLocation.Behiavours

The event defined in the editor.

◆ BoundingBox

BoundingBox _3DRadSpaceDll.EventOnLocation.BoundingBox

Bounding box.

◆ BoundingPlane

Plane _3DRadSpaceDll.EventOnLocation.BoundingPlane

Plane made up of

◆ BoundingSphere

BoundingSphere _3DRadSpaceDll.EventOnLocation.BoundingSphere

Bounding sphere.

◆ BoundingType

BoundingObject _3DRadSpaceDll.EventOnLocation.BoundingType

Sets the bounding type for the detection.

◆ ColidingObjects

List<int> _3DRadSpaceDll.EventOnLocation.ColidingObjects

A list containing the objects that are being detected by the box.

◆ Cube

Model _3DRadSpaceDll.EventOnLocation.Cube
static

A green transparent cube used to mark the bounding cube in the editor.

◆ Sphere

Model _3DRadSpaceDll.EventOnLocation.Sphere
static

A green trransparent sphere used to mark the bounding sphere in the editor.

◆ VisibleInEditor

bool _3DRadSpaceDll.EventOnLocation.VisibleInEditor

If yes, shows a green box marking the bounding zone.

Event Documentation

◆ OnObjectInside

OnBoundingObjectEnter _3DRadSpaceDll.EventOnLocation.OnObjectInside

Raised when a object is inside the bounding object.