![]() |
3DRadSpace
v1.0.0a
Scripting documentation
|
Allows raising events whenever a key is being pressed. More...
Public Member Functions | |
EventOnKey () | |
Empty EOK constructor. More... | |
EventOnKey (string name, bool enabled, KeyInput input, uint time_necesarry=0) | |
Main EOK constructor. More... | |
override void | Update (MouseState mouse, KeyboardState keyboard, GameTime time) |
![]() | |
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 | 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 | |
KeyInput | Key |
Defines the key and the expected key state. More... | |
new List< OpCodeCall > | Behiavours |
The event defined in the editor. More... | |
![]() | |
Vector3 | Position |
Object position More... | |
Vector3 | Rotation |
Rotation in a Euler angles system. More... | |
List< int > | SelectedObjects |
Used for editor. More... | |
Properties | |
uint | HoldingTime [get, set] |
Defined the time in milliseconds how much time is needed to hold down the given key to trigger the event. More... | |
uint | TotalHoldTime [get] |
Defnes how much time the button is being hold. More... | |
![]() | |
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< ObjectBehiavour > | Behiavours [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 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... | |
![]() | |
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... | |
Allows raising events whenever a key is being pressed.
_3DRadSpaceDll.EventOnKey.EventOnKey | ( | ) |
Empty EOK constructor.
_3DRadSpaceDll.EventOnKey.EventOnKey | ( | string | name, |
bool | enabled, | ||
KeyInput | input, | ||
uint | time_necesarry = 0 |
||
) |
Main EOK constructor.
name | Object Name. |
enabled | Will the event get raised? |
input | Defines the key and input type. |
time_necesarry | Time necessary for holding down the button in order to trigger the button. |
|
virtual |
mouse | |
keyboard | |
time |
Reimplemented from _3DRadSpaceDll.GameObject.
new List<OpCodeCall> _3DRadSpaceDll.EventOnKey.Behiavours |
The event defined in the editor.
KeyInput _3DRadSpaceDll.EventOnKey.Key |
Defines the key and the expected key state.
|
getset |
Defined the time in milliseconds how much time is needed to hold down the given key to trigger the event.
|
get |
Defnes how much time the button is being hold.