3DRadSpace  v1.0.0a
Scripting documentation
_3DRadSpaceDll Namespace Reference

Namespaces

namespace  OpcodeEvent
 

Classes

class  Camera
 3D Camera class. Allows drawing three dimensinal scenes. More...
 
class  Camera2D
 Camera class for 2D projects. Used to draw 2D scenes. More...
 
class  EventOnKey
 Allows raising events whenever a key is being pressed. More...
 
class  EventOnLocation
 Allows raising events when a object is within the specified bounding object. More...
 
class  EventOnValue
 You better use a Script object with a if statement. More...
 
class  ExitFade
 Allows loading other projects. More...
 
class  Fog
 
class  FPVCamera
 Represents a First person view camera. More...
 
class  Game
 Contains methods and fields for managing game objects. More...
 
class  GameObject
 Base class for all 3DRadSpace objects. More...
 
class  GameSettings
 Represents game's settings like fullscreen, framerate, resolution. More...
 
struct  KeyInput
 Input key used for the EventOnKey and related objects. More...
 
struct  ObjectBehiavour
 Specifies object relationships with other ones. More...
 
class  Project
 Project class for reading and saving projects. More...
 
class  ProjectBinary
 Loads and saved projects in binary format More...
 
class  SafeConverter
 Class that allows safe conversions between numeric types and strings. More...
 
class  Script
 C# Script class. More...
 
class  Skinmesh
 Class for drawing a 3D mesh. More...
 
class  Skybox
 Represents an Skybox object. More...
 
class  SkyColor
 Colors the screen when screen cleaning is used. More...
 
class  SoundEffect
 SoundEffect class. Allows loading and playing sound effects. More...
 
class  SoundSource
 Allows playing sounds located in a 3D envoirement. More...
 
class  Sprite
 2D Screen images class. More...
 
class  TextPrint
 Class for drawing 2D Texts. More...
 
class  Timer
 Executes an event everytime a 'period' passes for a number of times. More...
 

Enumerations

enum  KeyInputType { KeyInputType.Released =0, KeyInputType.Pressed, KeyInputType.Holding }
 Defines the input states. More...
 
enum  BoundingObject { BoundingObject.None, BoundingObject.Box, BoundingObject.Sphere, BoundingObject.Plane }
 Bounding objects types. More...
 
enum  ProjectType { ProjectType.TwoDimensional = 0, ProjectType.ThreeDimensional = 1, ProjectType.ScriptOnly = 2 }
 Project types for the editor. More...
 

Functions

delegate void KeyEvent (EventOnKey sender, GameTime delta)
 Triggers when the key is up/down/ hold for enough time. More...
 
delegate void OnKeyHold (EventOnKey sender, uint Time, GameTime deltaTime)
 Triggers when the key is being pressed and when the

See also
EventOnKey.Key, KeyInputType.Holding

.State is equal to More...

 
delegate void OnBoundingObjectEnter (EventOnLocation sender, BoundingObject boundingObject, GameObject Object_Inside)
 Event raised when a collision is happening. More...
 
delegate void onDraw (object drawn, SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Called when drawing the object More...
 
delegate void onUpdate (object updated, MouseState? mouse, KeyboardState? keyboard, GameTime time)
 Called when updating. More...
 
delegate void onObjectDestroy (object obj)
 Called when a object is being removed. More...
 
delegate void onObjectLoad (object obj)
 Called when a object resource is being loaded. More...
 
delegate void onObjectUnload (object obj)
 Called when a object is being unloaded. More...
 
delegate void onClick (object sender, MouseState mouse)
 Event is invoked when the object is being clicked. More...
 
delegate void TimerEvent (Timer sender, uint total_time)
 Raised everytime the timer exceeds the period. More...
 

Enumeration Type Documentation

◆ BoundingObject

Bounding objects types.

Enumerator
None 

Not defined.

Box 

AABB collision-type box

Sphere 

A 3D Sphere

Plane 

A 3D Plane

◆ KeyInputType

Defines the input states.

Enumerator
Released 

The key is up.

Pressed 

The key is being pressed.

Holding 

The key is being pressed for one than one frame.

◆ ProjectType

Project types for the editor.

Enumerator
TwoDimensional 

Strictly 2D.

ThreeDimensional 

3D

ScriptOnly 

Code only

Function Documentation

◆ KeyEvent()

delegate void _3DRadSpaceDll.KeyEvent ( EventOnKey  sender,
GameTime  delta 
)

Triggers when the key is up/down/ hold for enough time.

Parameters
senderEOK sender.
deltaDeltaTime.

◆ OnBoundingObjectEnter()

delegate void _3DRadSpaceDll.OnBoundingObjectEnter ( EventOnLocation  sender,
BoundingObject  boundingObject,
GameObject  Object_Inside 
)

Event raised when a collision is happening.

Parameters
senderAlways a EOL (EventOnLocation)
boundingObjectType of the bounding object
Object_InsideObject inside.

◆ onClick()

delegate void _3DRadSpaceDll.onClick ( object  sender,
MouseState  mouse 
)

Event is invoked when the object is being clicked.

Parameters
senderThe clicked object
mouseMouse information.

◆ onDraw()

delegate void _3DRadSpaceDll.onDraw ( object  drawn,
SpriteBatch  spriteBatch,
Matrix?  view,
Matrix?  projection 
)

Called when drawing the object

Parameters
drawnThe drawn object. Conversion will be needed.
spriteBatchSpriteBatch used for drawing 2D objects
viewView Matrix used for 3D model drawing
projectionProjection Matrix used for 3D model drawing

◆ OnKeyHold()

delegate void _3DRadSpaceDll.OnKeyHold ( EventOnKey  sender,
uint  Time,
GameTime  deltaTime 
)

Triggers when the key is being pressed and when the

See also
EventOnKey.Key, KeyInputType.Holding

.State is equal to

Parameters
sender
Time
deltaTime

◆ onObjectDestroy()

delegate void _3DRadSpaceDll.onObjectDestroy ( object  obj)

Called when a object is being removed.

Parameters
objThe removed object

◆ onObjectLoad()

delegate void _3DRadSpaceDll.onObjectLoad ( object  obj)

Called when a object resource is being loaded.

Parameters
objObject

◆ onObjectUnload()

delegate void _3DRadSpaceDll.onObjectUnload ( object  obj)

Called when a object is being unloaded.

Parameters
objObject to be unloaded

◆ onUpdate()

delegate void _3DRadSpaceDll.onUpdate ( object  updated,
MouseState?  mouse,
KeyboardState?  keyboard,
GameTime  time 
)

Called when updating.

Parameters
updatedThe updated object
mouseMouse inputs
keyboardKeyboard inputs
timeGame time input

◆ TimerEvent()

delegate void _3DRadSpaceDll.TimerEvent ( Timer  sender,
uint  total_time 
)

Raised everytime the timer exceeds the period.

Parameters
senderTimer object.
total_timeTotal time passed since the creation of the timer object.