Vortex v0.1a Documentation
Audio Clip
Public Fields
| Field |
Typename |
Description |
| Source (ReadOnly) |
AudioSource |
A reference to the the audio source component |
| Name (ReadOnly) |
string |
The name of the audio clip |
| Length (ReadOnly) |
float |
The length in seconds of the audio clip |
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Application
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
| Quit |
void |
None |
Exits the application on the next frame |
| GetSize |
Vector2 |
None |
Return the size of the window's framebuffer |
| GetPosition |
Vector2 |
None |
Returns the current position of the window |
| IsMaximized |
bool |
None |
Returns true if the application's window is maximized |
Cursor Mode
Public Fields
| Field |
Typename |
Description |
| Normal |
CursorMode |
Sets the cursor to the normal arrow, cursor motion is unlocked |
| Hidden |
CursorMode |
Hides the cursor when it is over the window, cursor motion is unlocked |
| Locked |
CursorMode |
Hides the cursor when it is over the window, cursor motion is locked |
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Public Fields
| Field |
Typename |
Description |
| A |
GamepadButton |
The A button on the gamepad |
| B |
GamepadButton |
The B button on the gamepad |
| X |
GamepadButton |
The X button on the gamepad |
| Y |
GamepadButton |
The Y button on the gamepad |
| LeftBumper |
GamepadButton |
The Left Bumper on the gamepad |
| RightBumper |
GamepadButton |
The Right Bumper on the gamepad |
| Guide |
GamepadButton |
The Guide button on the gamepad |
| Start |
GamepadButton |
The Start button on the gamepad |
| Back |
GamepadButton |
The Back button on the gamepad |
| Back |
LeftStick |
The Left Stick button on the gamepad |
| RightStick |
GamepadButton |
The Right Stick button on the gamepad |
| Up |
GamepadButton |
The Up button on the DPAD |
| Down |
GamepadButton |
The Down button on the DPAD |
| Left |
GamepadButton |
The Left button on the DPAD |
| Right |
GamepadButton |
The Right button on the DPAD |
| Cross |
GamepadButton |
The Cross button on the gamepad |
| Circle |
GamepadButton |
The Circle button on the gamepad |
| Square |
GamepadButton |
The Square button on the gamepad |
| Triangle |
GamepadButton |
The Triangle button on the gamepad |
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Gamepad Axis
Public Fields
| Field |
Typename |
Description |
| LeftX |
GamepadAxis |
The Left Stick's X axis on the gamepad |
| LeftY |
GamepadAxis |
The Left Stick's Y axis on the gamepad |
| RightX |
GamepadAxis |
The Right Stick's X axis on the gamepad |
| RightY |
GamepadAxis |
The Right Stick's Y axis on the gamepad |
| LeftTrigger |
GamepadAxis |
The Left Trigger axis on the gamepad |
| RightTrigger |
GamepadAxis |
The Right Trigger axis on the gamepad |
| Last |
GamepadAxis |
The total number of GamepadAxis options, useful for checking if any axis was changed |
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Gui
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
| Begin |
void |
string |
Begin a new Gui window with a name |
| Begin |
void |
string, Vector2 |
Begin a new Gui window with a name and position |
| Begin |
void |
string, float, float |
Begin a new Gui window with a name and size |
| Begin |
void |
string, Vector2, Vector2 |
Begin a new Gui window with a name, position and size |
| End |
void |
None |
Ends a Gui window, must be called after any overload of Begin |
| Underline |
void |
None |
Adds a single underline after the previous Gui element |
| Spacing |
void |
ulong |
Adds spacing after the previous Gui element |
| Text |
void |
string |
Adds a text element to the current Gui window |
| Button |
bool |
string |
Adds a button element to the current Gui window. Returns true if the button was clicked |
| Property |
bool |
out bool |
Adds a modifiable bool element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out int |
Adds a modifiable int element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out ulong |
Adds a modifiable ulong element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out float |
Adds a modifiable float element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out double |
Adds a modifiable double element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out Vector2 |
Adds a modifiable Vector2 element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out Vector3 |
Adds a modifiable Vector3 element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out Vector4 |
Adds a modifiable Vector4 element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out Color3 |
Adds a modifiable Color3 element to the current Gui window. Returns true if the value was modified |
| Property |
bool |
out Color4 |
Adds a modifiable Color4 element to the current Gui window. Returns true if the value was modified |
Public Fields
| Field |
Typename |
Description |
| MousePosition |
Vector2 |
The current position of the mouse cursor |
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
| IsKeyPressed |
bool |
KeyCode |
Returns true if the given key was pressed during the current frame |
| IsKeyReleased |
bool |
KeyCode |
Returns true if the given key was released during the current frame |
| IsKeyDown |
bool |
KeyCode |
Returns true if the given key was down during the current frame |
| IsKeyUp |
bool |
KeyCode |
Returns true if the given key was up during the current frame |
| IsMouseButtonPressed |
bool |
MouseButton |
Returns true if the given button was pressed during the current frame |
| IsMouseButtonReleased |
bool |
MouseButton |
Returns true if the given button was released during the current frame |
| IsMouseButtonDown |
bool |
MouseButton |
Returns true if the given button was down during the current frame |
| IsMouseButtonUp |
bool |
MouseButton |
Returns true if the given button was up during the current frame |
Key Code
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Public Fields
| Field |
Typename |
Description |
| Left |
MouseButton |
The Left Mouse button |
| Middle |
MouseButton |
The Middle Mouse button, a.k.a. the mouse wheel button |
| Right |
MouseButton |
The Right Mouse button |
| Last |
MouseButton |
The total number of MouseButton options, useful for checking if any button was pressed |
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Log
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
| Print |
void |
string |
Prints the message to the editor console |
| Print |
void |
object |
Converts the object to a string and prints to the editor console |
| Info |
void |
string |
Prints a Info message to the editor console |
| Info |
void |
object |
Converts the object to a string and prints a Info message to the editor console |
| Warn |
void |
string |
Prints a Warning message to the editor console |
| Warn |
void |
object |
Converts the object to a string and prints a Warning message to the editor console |
| Error |
void |
string |
Prints a Error message to the editor console |
| Error |
void |
object |
Converts the object to a string and prints a Error message to the editor console |
| Fatal |
void |
string |
Prints a Fatal message to the editor console |
| Fatal |
void |
object |
Converts the object to a string and prints a Fatal message to the editor console |
Random
Public Fields
| Field |
Parameters |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Time
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Mathf
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
v
Parameters |
Description |
|
|
|
Matrix4
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Noise
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Quaternion
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Vector2
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Vector3
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Vector4
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Physics
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Physics2D
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Color
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Debug Renderer
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Material
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Scene Renderer
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Submesh
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Texture2D
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Entity
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Scene
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
SceneManager
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Camera
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
LightSource
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
TextMesh
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Animation
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Animator
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
MeshRenderer
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
StaticMeshRenderer
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
SpriteRenderer
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
CircleRenderer
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
AudioSource
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
AudioListener
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
RigidBody
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
CharacterController
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
FixedJoint
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
PhysicsMaterial
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
BoxCollider
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
SphereCollider
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
CapsuleCollider
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
MeshCollider
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
RigidBody2D
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
BoxCollider2D
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
CircleCollider2D
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
ParticleEmitter
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|
Script
Public Fields
| Field |
Typename |
Description |
|
|
|
Public Methods
| Method |
Return Type |
Parameters |
Description |
|
|
|