Unigine.Game Class

Game Class

Properties

Player Player#

Vec3 p0, p1;

		// get the current player (camera)
		Player player = Game.Player;
		if (player == null)
			return;

		// get width and height of the current application window
		EngineWindow main_window = WindowManager.MainWindow;
		if (!main_window)
		{
			Engine.Quit();
			return;
		}
		ivec2 main_size = main_window.Size;

		// get the current X and Y coordinates of the mouse pointer
		int mouse_x = Gui.GetCurrent().MouseX;
		int mouse_y = Gui.GetCurrent().MouseY;

		// get the mouse direction from the player's position (p0) to the mouse cursor pointer (p1)
		player.GetDirectionFromScreen(out p0, out p1, mouse_x, mouse_y, 0, 0, main_size.x, main_size.y);

Player PlayerListener#

int Seed#

float Time#

float Scale#

float IFps#

Node node;
		// ...
		// get an inverse FPS value
		float ifps = Game.IFps;
			
		// move the node up by 0.1 unit every second instead of every frame
		node.WorldTranslate(new Vec3(0.0f, 0.0f, 0.1f*ifps));

int Frame#

// get the current game frame
		int loading_frames = Game.Frame;
		// perform asynchronous nodes loading
		// ...
		// calculate the number of game frames required for nodes loading
		loading_frames = Game.Frame - loading_frames;

string Data#

<world version="1.21">
	<game>
		<data>User data</data>
	</game>
</world>

bool Enabled#

vec4 RandomColor#

uint Random#

Members

Obstacle GetIntersection ( vec3 p0, vec3 p1, float radius, int mask, Node[] exclude, vec3[] intersection ) #

Arguments

• vec3 p0 - Start point.
• vec3 p1 - End point.
• float radius - Radius of the intersection cylinder.
• int mask - Obstacle intersection mask. The obstacle is ignored if its mask does not match.
• Node[] exclude - Array with excluded obstacles. These obstacle nodes are ignored when performing intersection.
• vec3[] intersection - Intersection point.

Return value

Obstacle GetIntersection ( vec3 p0, vec3 p1, float radius, int mask, GameIntersection intersection ) #

Performs intersection to find if a pathfinding obstacle is located within the cylinder between two points.

The following example shows how you can get the intersection point (vec3) of the cylinder between two points with an obstacle. In this example we specify a cylinder from the point of the camera (vec3 p0) to the point of the mouse pointer (vec3 p1) with the specified radius. The executing sequence is the following:

1. Define and initialize two points (p0 and p1) by using the Player.GetDirectionFromScreen() function.
2. Create an instance of the GameIntersection class to get the intersection point coordinates.
3. Check, if there is an intersection with an obstacle. The Game.GetIntersection() function returns an intersected obstacle when the obstacle appears in the area of the cylinder.
4. After that GameIntersection instance gets the point of the nearest intersection point and you can get it by using the Point property.

/* ... */
		// initialize points of the mouse direction
		Vec3 p0, p1;

		// get the current player (camera)
		Player player = Game.Player;
		if (player == null)
			return;
		// get the size of the current application window
		EngineWindow main_window = WindowManager.MainWindow;
		if (!main_window)
		{
			Engine.Quit();
			return;
		}

		ivec2 main_size = main_window.Size;

		// get the current X and Y coordinates of the mouse pointer
		int mouse_x = Input.MousePosition.x - main_window.Position.x;
		int mouse_y = Input.MousePosition.y - main_window.Position.y;

		// get the mouse direction from the player's position (p0) to the mouse cursor pointer (p1)
		player.GetDirectionFromScreen(out p0, out p1, 0, 0, mouse_x, mouse_y, main_size.x, main_size.y);

		// create an instance of the GameIntersection class
		GameIntersection intersection = new GameIntersection();

		// try to get the intersection with an obstacle
		// cylinder has radius 1.5f, intersection mask equals to 1
		Obstacle obstacle = Game.GetIntersection(p0, p1, 1.5f, 1, intersection);

		// check, if the intersection of mouse direction with any obstacle was occurred;
		if (obstacle != null)
		{
			// show the coordinates of the intersection in console 
			Log.Message("The intersection with the obstacle was here: ({0} {1} {2})\n", intersection.Point.x, intersection.Point.y, intersection.Point.z);
		}
		/* ... */

Arguments

• vec3 p0 - Start point.
• vec3 p1 - End point.
• float radius - Radius of the intersection cylinder.
• int mask - Obstacle intersection mask. The obstacle is ignored if its mask does not match.
• GameIntersection intersection - GameIntersection class instance to put the result into.

Return value

float GetNoise1 ( float pos, float size, int frequency ) #

Arguments

• float pos - Float position.
• float size - Size of the noise.
• int frequency - Noise frequency.

Return value

float GetNoise2 ( vec2 pos, vec2 size, int frequency ) #

Arguments

• vec2 pos - vec2 point position.
• vec2 size - vec2 size of the noise.
• int frequency - Noise frequency.

Return value

float GetNoise3 ( vec3 pos, vec3 size, int frequency ) #

Arguments

• vec3 pos - vec3 point position.
• vec3 size - vec3 size of the noise.
• int frequency - Noise frequency.

Return value

double GetRandomDouble ( double from, double to ) #

Arguments

• double from - The initial point of the range.
• double to - The end point of the range.

Return value

float GetRandomFloat ( float from, float to ) #

Arguments

• float from - The initial point of the range.
• float to - The end point of the range.

Return value

int GetRandomInt ( int from, int to ) #

Arguments

• int from - The initial point of the range.
• int to - The end point of the range.

Return value

void GetMainPlayers ( Player[] players ) #

Arguments

• Player[] players - Array of pointers to main players.

void SetPlayerListener ( Player listener ) #

Arguments

• Player listener - Player to be set as listener.

Player GetPlayerListener ( ) #

Return value

void GetListeners ( Player[] players ) #

Arguments

• Player[] players - List to store potential listeners.