Getting Started Examples - Revision history

JimmyAkl at 11:13, 12 October 2021

2021-10-12T11:13:26Z

← Older revision		Revision as of 07:13, 12 October 2021
Line 1:		Line 1:
	Here are a few examples for beginners wanting to get into Graal3D. You will need to have both the '''~~Graal3D~~ Client''' and '''RC''' downloaded. You will also need an authorized account to be able to login to the server.		Here are a few examples for beginners wanting to get into Graal3D. You will need to have both the '''Worlds Client''' and '''RC''' downloaded. You will also need an authorized account to be able to login to the server.
	#Download the build compressed file, uncompress it and run the Build application.		#Download the build compressed file, uncompress it and run the Build application.
	#Login with your GraalID and password, a window will open containing Worlds and Account info.		#Login with your GraalID and password, a window will open containing Worlds and Account info.

JimmyAkl at 17:31, 2 September 2021

2021-09-02T17:31:41Z

← Older revision		Revision as of 13:31, 2 September 2021
Line 134:		Line 134:
	for (temp.y = 0; temp.y < this.height; ++temp.y) {		for (temp.y = 0; temp.y < this.height; ++temp.y) {
	for (temp.x = 0; temp.x < this.width; ++temp.x) {		for (temp.x = 0; temp.x < this.width; ++temp.x) {
	GameObject::CreatePrimitive(PrimitiveType::Cube).transform.position = ~~Vector3::create~~(player.x - 5 + temp.x, temp.y, player.y + 1);		GameObject::CreatePrimitive(PrimitiveType::Cube).transform.position = v3(player.x - 5 + temp.x, temp.y, player.y + 1);
	}		}
	}		}
Line 144:		Line 144:
	*The “ . ” for methods is replaced by “:: ”		*The “ . ” for methods is replaced by “:: ”
	'''Function format:''' Unity C#: '''''Type.method''''' => Graal Script: '''''Type::Method'''''		'''Function format:''' Unity C#: '''''Type.method''''' => Graal Script: '''''Type::Method'''''
	*'''''~~Vector3::Create~~(x,y,z)''''' replaces '''new''' '''''Vector3(x,y,z)'''''		*'''''v3(x,y,z)''''' replaces '''new''' '''''Vector3(x,y,z)'''''
	*The Gameobject is instantiated close to the player using (player.x and player.y)		*The Gameobject is instantiated close to the player using (player.x and player.y)
	[[File:Wall.png\|frameless\|695x695px]]		[[File:Wall.png\|frameless\|695x695px]]
Line 202:		Line 202:
	temp.y1 = sin(temp.angle) * temp.radius;		temp.y1 = sin(temp.angle) * temp.radius;
	temp.cube = GameObject::CreatePrimitive(PrimitiveType::Cube);		temp.cube = GameObject::CreatePrimitive(PrimitiveType::Cube);
	temp.cube.transform.position = ~~Vector3::create~~(player.x + temp.x1, player.z, player.y + temp.y1);		temp.cube.transform.position = v3(player.x + temp.x1, player.z, player.y + temp.y1);
	temp.angleDegrees = -temp.angle * Mathf::Rad2Deg;		temp.angleDegrees = -temp.angle * Mathf::Rad2Deg;
	temp.cube.transform.rotation = Quaternion::euler(0, temp.angleDegrees, 0);		temp.cube.transform.rotation = Quaternion::euler(0, temp.angleDegrees, 0);
Line 236:		Line 236:
	function onCreated(){		function onCreated(){
	this.cube = GameObject::CreatePrimitive(PrimitiveType::Cube);		this.cube = GameObject::CreatePrimitive(PrimitiveType::Cube);
	this.cube.transform.position = ~~Vector3::create~~(player.x,player.z,player.y);		this.cube.transform.position = v3(player.x,player.z,player.y);
	this.height = 10;//max height of Box's movement		this.height = 10;//max height of Box's movement
	this.yCenter = 0.0;		this.yCenter = 0.0;
Line 243:		Line 243:

	function onTimeout() {		function onTimeout() {
	this.cube.transform.position = ~~Vector3::create~~(this.cube.transform.position.x,this.yCenter + Mathf::PingPong(Time::time *2, this.height) - height / 2.0,this.cube.transform.position.z);		this.cube.transform.position = v3(this.cube.transform.position.x,this.yCenter + Mathf::PingPong(Time::time *2, this.height) - height / 2.0,this.cube.transform.position.z);
	SetTimer(0.001);		SetTimer(0.001);
	}		}
Line 258:		Line 258:
	SetTimer(9999);		SetTimer(9999);
	this.cube = GameObject::CreatePrimitive(PrimitiveType::Cube);		this.cube = GameObject::CreatePrimitive(PrimitiveType::Cube);
	this.cube.transform.position = ~~Vector3::create~~(player.x + 5, player.z, player.y);		this.cube.transform.position = v3(player.x + 5, player.z, player.y);
	this.cube.AddComponent(Type::RigidBody);		this.cube.AddComponent(Type::RigidBody);
	Quattro::EventManager::AddOnCollisionHandlerTo(this.cube, this.cube.layer);		Quattro::EventManager::AddOnCollisionHandlerTo(this.cube, this.cube.layer);
Line 289:		Line 289:
	The two parameters:		The two parameters:

	'''gameobject:''' it is the ~~gameobject~~ that was just used to detect collision (''the cube in our example'')		'''gameobject:''' it is the Gameobject that was just used to detect collision (''the cube in our example'')

	'''collision:''' describes the collider we hit, you can retrieve the GameObject collided with by using : '''''collision.GameObject'''.''		'''collision:''' describes the collider we hit, you can retrieve the GameObject collided with by using: '''''collision.GameObject'''.''

	'''Note:''' Whenever we use collisions, the '''''SetTimer(9999)''''' is essential; it will keep the script alive and always checking for events. the Unity function OnUpdate() will be triggered for every frame.		'''Note:''' Whenever we use collisions, the '''''SetTimer(9999)''''' is essential; it will keep the script alive and always checking for events. the Unity function OnUpdate() will be triggered for every frame.

JimmyAkl at 11:37, 10 July 2021

2021-07-10T11:37:56Z

← Older revision		Revision as of 07:37, 10 July 2021
Line 126:		Line 126:
	We are going to mimic the second C# script since it would be useless to upload a Cube prefab to the server, when we can simply instantiate them using PrimitiveType.		We are going to mimic the second C# script since it would be useless to upload a Cube prefab to the server, when we can simply instantiate them using PrimitiveType.

	The same script above will look like this in GraalScript: ('''''Weapon:''''' ''3D/~~Jimmy~~/~~Example2~~'')		The same script above will look like this in GraalScript: ('''''Weapon:''''' ''3D/Samples/Examples/BuildingWall'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	//#CLIENTSIDE		//#CLIENTSIDE
Line 192:		Line 192:
	Just like before we could’ve just used '''''GameObject.CreatePrimitive(PrimitiveType.Cube)''''' to create the cubes and then change the transform.position and the transform.rotation.		Just like before we could’ve just used '''''GameObject.CreatePrimitive(PrimitiveType.Cube)''''' to create the cubes and then change the transform.position and the transform.rotation.
	====Using Graal3D====		====Using Graal3D====
	Again, since we don’t want to upload useless PrimitiveType prefabs to the server, we use this approach: ('''''Weapon:''''' ''3D/~~Jimmy~~/~~Example2~~'')		Again, since we don’t want to upload useless PrimitiveType prefabs to the server, we use this approach: ('''''Weapon:''''' ''3D/Samples/Examples/CircleFormation'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	function onCreated() {		function onCreated() {
Line 231:		Line 231:
	Here we use the Update function. As its name suggests, it will serve to update gameplay and move the cube up and down depending on the time.		Here we use the Update function. As its name suggests, it will serve to update gameplay and move the cube up and down depending on the time.
	====Using Graal3D====		====Using Graal3D====
	('''''Weapon:''''' ''3D/~~Merlin~~/~~Samples~~/MovingCube'')		('''''Weapon:''''' ''3D/Samples/Examples/MovingCube'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	//#CLIENTSIDE		//#CLIENTSIDE
Line 251:		Line 251:
	===Cube with Physics - Using Physics and Collision===		===Cube with Physics - Using Physics and Collision===
	In this example we will add physics to our Gameobject, it will be subject to gravity, forces and collisions with other Gameobjects. We will also see how to detect and handle these collisions.		In this example we will add physics to our Gameobject, it will be subject to gravity, forces and collisions with other Gameobjects. We will also see how to detect and handle these collisions.

			('''''Weapon:''''' ''3D/Samples/Examples/SimplePhysicObject'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	//#CLIENTSIDE		//#CLIENTSIDE

JimmyAkl at 13:13, 8 July 2021

2021-07-08T13:13:47Z

← Older revision		Revision as of 09:13, 8 July 2021
Line 126:		Line 126:
	We are going to mimic the second C# script since it would be useless to upload a Cube prefab to the server, when we can simply instantiate them using PrimitiveType.		We are going to mimic the second C# script since it would be useless to upload a Cube prefab to the server, when we can simply instantiate them using PrimitiveType.

	The same script above will look like this in GraalScript:		The same script above will look like this in GraalScript: ('''''Weapon:''''' ''3D/Jimmy/Example2'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	//#CLIENTSIDE		//#CLIENTSIDE
Line 192:		Line 192:
	Just like before we could’ve just used '''''GameObject.CreatePrimitive(PrimitiveType.Cube)''''' to create the cubes and then change the transform.position and the transform.rotation.		Just like before we could’ve just used '''''GameObject.CreatePrimitive(PrimitiveType.Cube)''''' to create the cubes and then change the transform.position and the transform.rotation.
	====Using Graal3D====		====Using Graal3D====
	Again, since we don’t want to upload useless PrimitiveType prefabs to the server, we use this approach:		Again, since we don’t want to upload useless PrimitiveType prefabs to the server, we use this approach: ('''''Weapon:''''' ''3D/Jimmy/Example2'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	function onCreated() {		function onCreated() {
Line 231:		Line 231:
	Here we use the Update function. As its name suggests, it will serve to update gameplay and move the cube up and down depending on the time.		Here we use the Update function. As its name suggests, it will serve to update gameplay and move the cube up and down depending on the time.
	====Using Graal3D====		====Using Graal3D====
			('''''Weapon:''''' ''3D/Merlin/Samples/MovingCube'')
	findplayer("GraalID").addweapon(this.name);		findplayer("GraalID").addweapon(this.name);
	//#CLIENTSIDE		//#CLIENTSIDE

JimmyAkl at 06:41, 12 June 2021

2021-06-12T06:41:29Z

← Older revision		Revision as of 02:41, 12 June 2021
Line 266:		Line 266:
	''Cube with Physics - Graal Script''		''Cube with Physics - Graal Script''

	We create and place a Cube just like the examples before~~. To add physics to the Gameobject, we add the '''RigidBody Component'''~~.		We create and place a Cube just like the examples before.

	~~The~~ Quattro::EventManager::AddOnCollisionHandlerTo() function ~~will a~~ collision ~~handler~~.		To add physics to the GameObject, we add the '''RigidBody Component''';
			{\| class="wikitable"
			!this.cube.AddComponent(Type::RigidBody);
			\|}
			Now to add a Collision Handler;
			{\| class="wikitable"
			!''Quattro::EventManager::AddOnCollisionHandlerTo()''
			\|}
			And
			{\| class="wikitable"
			!''this.catcheventobject(GameObject, “onCollisionEnter”, “onFunctionName”)''
			\|}
			Which will catch collision and call the function '''''onFunctionName()''''' that you have to implement;
			public function onCubeCollisionEnter(gameobject, collision) {
			player.chat = "Collision!";
			}
			The two parameters:

	~~And this.catcheventobject~~(~~GameObject, “onCollisionEnter”, “”~~)		'''gameobject:''' it is the gameobject that was just used to detect collision (''the cube in our example'')

	~~The onCubeCollisionEnter(gameobject~~, collision~~) will trigger functionalities upon collision~~.		'''collision:''' describes the collider we hit, you can retrieve the GameObject collided with by using : '''''collision.GameObject'''.''

	Note: Whenever we use collisions, the SetTimer(9999) is essential, it will keep the script alive and always checking for events.		'''Note:''' Whenever we use collisions, the '''''SetTimer(9999)''''' is essential; it will keep the script alive and always checking for events. the Unity function OnUpdate() will be triggered for every frame.

JimmyAkl at 06:19, 4 June 2021

2021-06-04T06:19:29Z

← Older revision		Revision as of 02:19, 4 June 2021
Line 1:		Line 1:
	~~In this section you~~ will need to have both the '''Graal3D Client''' and '''RC''' downloaded. You will also need an authorized account to be able to login to the server.		Here are a few examples for beginners wanting to get into Graal3D. You will need to have both the '''Graal3D Client''' and '''RC''' downloaded. You will also need an authorized account to be able to login to the server.
	#Download the build compressed file, uncompress it and run the Build application.		#Download the build compressed file, uncompress it and run the Build application.
	#Login with your GraalID and password, a window will open containing Worlds and Account info.		#Login with your GraalID and password, a window will open containing Worlds and Account info.
Line 6:		Line 6:


	Once logged in, you're required to know how to use the tools that allow you to warp to different levels, debug your code... Unity tools are also available as well.		Once logged in, you're required to know how to use the tools that allow you to warp to different levels, debug your code... Unity tools are also available as well.

	An explanation of all the tools is available here: [[Tools]]		An explanation of all the tools is available here: [[Tools]]
	===Building a Wall Example - ''Creating prefabs and instantiating them''===		===Building a Wall Example - ''Creating prefabs and instantiating them''===
	This example is found in the Unity Manual. We will build a wall using primitive type Cubes as Gameobjects. It will be demonstrated using Unity C# and on Graal3D using Graalscript.		This example is found in the Unity Manual; We will build a wall using primitive type Cubes as Gameobjects. It will be demonstrated using Unity C# and on Graal3D using Graalscript.
	====Using Unity====		====Using Unity====
	Open the Unity editor with a new project.		Open the Unity editor with a new project.
Line 20:		Line 20:
	This Gameobject will hold our script to build a wall.		This Gameobject will hold our script to build a wall.

	[[~~index.php?title=~~File:1.png\|frameless~~\|419x419px~~]]		[[File:1.png\|frameless]]

	'''Step2: Creating a Prefab'''		'''Step2: Creating a Prefab'''
Line 63:		Line 63:

	[[File:Prefab.png\|frameless]]		[[File:Prefab.png\|frameless]]



Line 76:		Line 77:
	\|}The '''Start''' function is where you instantiate your Gameobjects.		\|}The '''Start''' function is where you instantiate your Gameobjects.

	The '''Update''' function is where the gameplay updates happen (Gameobject movement, triggering actions, taking user input...). It is similar to the onTimeOut / onMouseDown / onKeyPressed... functions in ~~graalscript~~.		The '''Update''' function is where the gameplay updates happen (Gameobject movement, triggering actions, taking user input...). It is similar to the onTimeOut / onMouseDown / onKeyPressed... functions in Graalscript.

	'''Important Note:'''		'''Important Note:'''

	[[File:Coordinates.png\|frameless]]		[[File:Coordinates.png\|frameless]]

JimmyAkl at 04:17, 29 May 2021

2021-05-29T04:17:34Z

Show changes

JimmyAkl at 07:05, 26 May 2021

2021-05-26T07:05:01Z

Show changes

JimmyAkl at 05:55, 26 May 2021

2021-05-26T05:55:24Z

← Older revision		Revision as of 01:55, 26 May 2021
Line 33:		Line 33:

	'''Note:''' Make sure you name the public class the same name as your script file.		'''Note:''' Make sure you name the public class the same name as your script file.
	~~{\| class="wikitable"~~		using System.Collections;
	\|using System.Collections;		using System.Collections.Generic;
			using UnityEngine;
	using System.Collections.Generic;		public class wall : MonoBehaviour{
			public GameObject block;
	using UnityEngine;		public int width = 10;
			public int height = 4;
	public class wall : MonoBehaviour		void Start(){
			for (int y = 0; y < height; ++y){
	{		for (int x = 0; x < width; ++x){
			Instantiate(block, new Vector3(x, y, 0), Quaternion.identity);
	~~public~~ GameObject block;		}
			}
	~~public~~ int width = 10;		}
			}
	~~public~~ int height = 4;

	~~void~~ Start()

	{

	~~for~~ (int y = 0; y < height; ++y)

	{

	~~for~~ (int x = 0; x < width; ++x)

	{

	~~Instantiate~~(block, new Vector3(x, y, 0), Quaternion.identity);

	}

	}

	}

	}
	\|}
	''Building a Wall - C# Script''		''Building a Wall - C# Script''

JimmyAkl at 05:50, 26 May 2021

2021-05-26T05:50:38Z

← Older revision		Revision as of 01:50, 26 May 2021
Line 35:		Line 35:
	{\| class="wikitable"		{\| class="wikitable"
	\|using System.Collections;		\|using System.Collections;

	using System.Collections.Generic;		using System.Collections.Generic;

	using UnityEngine;		using UnityEngine;

	public class wall: MonoBehaviour		public class wall : MonoBehaviour

	{		{

	~~public~~ GameObject block;		public GameObject block;

	~~public~~ int width = 10;		public int width = 10;

	public int height = 4;		public int height = 4;
Line 70:		Line 71:

	}		}
	\|}''Building a Wall - C# Script''		\|}
			''Building a Wall - C# Script''

	Finally, you’ll need to add the block prefab that we’ve created earlier to script component (to replace the public Gameobject variable “block” in the script) (Fig.3)		Finally, you’ll need to add the block prefab that we’ve created earlier to script component (to replace the public Gameobject variable “block” in the script) (Fig.3)