Переход на UNIGINE с Unity: программирование

Game logic in a Unity project is implemented via Script components. You got used to determine GameObject's behavior by writing event functions like Start(), Update(), etc.Игровая логика в проекте Unity реализована через компоненты Script . Вы привыкли определять поведение GameObject, записывая функции событий, такие как Start(), Update() и т.д.

UNIGINE has quite a similar concept, which can be easily adopted — C# Component System, which is safe and secure and ensures high performance. Logic is written in C# components that can be assigned to any node in the scene. Each component has a set of functions (Init(), Update(), etc.), that are called by the corresponding functions of the engine main loop.UNIGINE имеет довольно похожую концепцию, которая может быть легко адаптирована - Система компонентов C# , который безопасен и надежен и обеспечивает высокую производительность. Логика написана на компонентах C#, которые могут быть назначены любому узлу сцены. Каждый компонент имеет набор функций (Init(), Update() и т.д.), Которые вызываются соответствующими функциями основного цикла движка.

Programming in UNIGINE using C# is not much different from programming in Unity software. For example, let's compare how rotation is performed in Unity software:Программирование в UNIGINE с использованием C# мало чем отличается от программирования в программном обеспечении Unity. Например, сравним, как выполняется вращение в программе Unity:

using UnityEngine;

public class MyComponent : MonoBehaviour
{
    public float speed = 90.0f;

    void Update()
    {
        transform.Rotate(0, speed * Time.deltaTime, 0, Space.Self);
    }
}

and in UNIGINE:и в UNIGINE:

using Unigine;
/* .. */
public class MyComponent : Component
{
	public float speed = 90.0f;
	
	void Update()
	{
		node.Rotate(0, 0, speed * Game.IFps);
	}
}

The Run button is available in the Editor to run an instance of the application in a separate window. Along with the button, there are settings available to fine-tune run options.Кнопка Run доступна в редакторе для запустить экземпляр приложения в отдельном окне. Наряду с кнопкой доступны настройки для точной настройки параметров запуска.

That's how we'll make the wheel rotate using C# Component System and run an instance to immediately check it:Вот как можно заставить колесо вращаться с помощью C# Component System и запустить из редактора приложение в отдельном окне, чтобы немедленно его проверить:

Moreover in UNIGINE, you can also implement Application Logic for the whole application by writing code in the AppWorldLogic.cs, AppSystemLogic.cs and AppEditorLogic.cs files stored in the source/ project folder.Кроме того, в UNIGINE вы также можете реализовать логику приложения для всего приложения путем написания кода в файлах AppWorldLogic.cs, AppSystemLogic.cs и AppEditorLogic.cs, хранящихся в папке проекта source/.

To learn more about the execution sequence and how to build components, follow the links below:Чтобы узнать больше о последовательности выполнения и о том, как создавать компоненты, перейдите по ссылкам ниже:

• Execution SequenceПоследовательность выполнения
• Video tutorial on C# Component SystemВидеоурок по системе компонентов C#

For those who prefer C++, UNIGINE allows creating C++ applications using C++ API and, if required, C++ Component System.Для тех, кто предпочитает C++, UNIGINE позволяет создавать C++ приложения с использованием C++ API и, при необходимости, Системы компонентов C++ .

Printing to ConsoleПечать в консоль#

Debug.Log("Text: " + text);
Debug.LogFormat("Formatted text: {0}", text);

Log.Message("Debug info:" + text + "\n");
Log.Message("Debug info: {0}\n", new vec3(1, 2, 3));

Accessing the GameObject / Node from ComponentДоступ к GameObject / Node из компонента#

GameObject this_go = gameObject;
string n = gameObject.name;

Node this_node = node;
string n = node.Name;

Working with DirectionsРабота с маршрутами#

In Unity software to get a vector on a certain axis while also considering the rotation of a game object in world coordinates, you use the corresponding properties of the Transform component. The same vector in UNIGINE is got by using Node.GetWorldDirection() function:В программном обеспечении Unity для получения вектора на определенной оси с учетом вращения игрового объекта в мировых координатах используются соответствующие свойства компонента Transform. Тот же вектор в UNIGINE получается с помощью функции Node.GetWorldDirection():

Unity software	UNIGINE
Исходный код (C#) Vector3 forward = transform.forward; Vector3 right = transform.right; Vector3 up = transform.up; transform.Translate(forward * speed * Time.deltaTime);	Исходный код (C#) vec3 forward = node.GetWorldDirection(MathLib.AXIS.Y); vec3 right = node.GetWorldDirection(MathLib.AXIS.X); vec3 up = node.GetWorldDirection(MathLib.AXIS.Z); node.Translate(forward * speed * Game.IFps);

Примечание

Intances of the Players-Related classes use different direction vectors and are to be treated correspondingly.Экземпляры Player-классов используют другие векторы направления и требуют соответствующего обращения .

See AlsoСмотрите также#

• Coordinate System in UNIGINEСистема координат в UNIGINE

Smoother Gameplay with DeltaTime / IFpsБолее плавный игровой процесс с DeltaTime / IFps#

transform.Rotate(0, speed * Time.deltaTime, 0, Space.Self);

node.Rotate(0, 0, speed * Game.IFps);

Drawing Debug DataРисование отладочных данных#

Unity software:Unity программное обеспечение:

Исходный код (C#)

Debug.DrawLine(Vector3.zero, new Vector3(5, 0, 0), Color.white, 2.5f);

Vector3 forward = transform.TransformDirection(Vector3.forward) * 10;
Debug.DrawRay(transform.position, forward, Color.green);

UNIGINE:

Исходный код (C#)

Visualizer.Enabled = true;

/*..*/

Visualizer.RenderLine3D(vec3.ZERO, new vec3(5, 0, 0), vec4.ONE);
Visualizer.RenderVector(node.Position, node.GetDirection(MathLib.AXIS.Y) * 10, new vec4(1, 0, 0, 1));

Примечание

The visualizer can be toggled on and off via show_visualizer 1 console command as well.Визуализатор также можно включать и выключать с помощью консольной команды show_visualizer 1.

See AlsoСмотрите также#

• More types of visualizations in the Visualizer class API.Больше типов визуализаций в API класса Visualizer.

Loading a SceneЗагрузка сцены#

SceneManager.LoadScene("YourSceneName",LoadSceneMode.Single);

World.LoadWorld("YourSceneName");

Accessing a Component from the GameObject / NodeДоступ к компоненту из GameObject / Node#

MyComponent my_component = gameObject.GetComponent<MyComponent>();

MyComponent my_component = node.GetComponent<MyComponent>();
MyComponent my_component = GetComponent<MyComponent>(node);

// accessing the transform of the game object
Transform transform_1 = gameObject.GetComponent<Transform>();
Transform transform_2 = gameObject.transform;

// accessing the Mesh Renderer component
MeshRenderer mesh_renderer = gameObject.GetComponent<MeshRenderer>();

// accessing the Rigidbody component
Rigidbody rigidbody = gameObject.GetComponent<Rigidbody>();

// accessing a collider
Collider collider = gameObject.GetComponent<Collider>();
BoxCollider boxCollider = collider as BoxCollider;

// getting the transformation matrix of the node
mat4 transform = node.WorldTransform;

// downcasting the node to the ObjectMeshStatic class
ObjectMeshStatic mesh_static = node as ObjectMeshStatic;

// accessing the rigid body assigned to the node
Body body = (node as Unigine.Object).Body;
BodyRigid rigid = body as BodyRigid;

// fetch all collision shapes of the ShapeBox type
for (int i = 0; i < body.NumShapes; i++)
{
	Shape shape = body.GetShape(i);
	if (shape is ShapeBox)
	{
		ShapeBox shape_box = shape as ShapeBox;
		...
	}
}

Finding GameObjects / NodesПоиск GameObject / Node#

// Find a GameObject by name
GameObject myGameObj = GameObject.Find("My Game Object");

// Find the child named "ammo" of the gameobject "magazine" (magazine is a child of "gun").
Transform ammo_transform = gameObject.transform.Find("magazine/ammo");
GameObject ammo = ammo_transform.gameObject;

// Find GameObjects by the type of component assigned
MyComponent[] components = Object.FindObjectsOfType<MyComponent>();
foreach (MyComponent component in components)
{
        // ...
}

// Find GameObjects by tag
GameObject[] taggedGameObjects = GameObject.FindGameObjectsWithTag("MyTag");
foreach (GameObject gameObj in taggedGameObjects)
{
        // ...
}

// Find a Node by name
Node my_node = World.GetNodeByName("my_node");

// Find all nodes having this name
List<Node> nodes = new List<Node>();
World.GetNodesByName("my_node");

// Find the index of a direct child node
int index = node.FindChild("child_node");
Node direct_child = node.GetChild(index);

// Perform a recursive descend down the hierarchy to find a child Node by name
Node child = node.FindNode("child_node", 1);

// Find Nodes by the type of component assigned
MyComponent[] my_comps = FindComponentsInWorld<MyComponent>();
foreach(MyComponent comp in my_comps)
{
	Log.Message("{0}\n",comp.node.name);
}

Casting From Type to TypeПриведение типов#

Collider collider = gameObject.GetComponent<Collider>;
BoxCollider boxCollider = collider as BoxCollider;

Node node = World.GetNodeByName("my_mesh");
ObjectMeshStatic mesh = node as ObjectMeshStatic;

Collider collider = gameObject.GetComponent<Collider>;
BoxCollider boxCollider = collider as BoxCollider;
Collider coll = boxCollider;

Node node = World.GetNodeByName("my_mesh");
ObjectMeshStatic mesh = node as ObjectMeshStatic;
Unigine.Object obj = mesh;

Destroy GameObject/NodeУдаление GameObject / Node#

Destroy(maGameObject);

// destroy the game object with 1 second delay
Destroy(maGameObject, 1);

node.DeleteLater(); // recommended option
//called between the current and the next frames

node.DeleteForce(); // called during the same frame but unsafe

// LifetimeController.cs

/* .. */
public class LifetimeController : Component
{
	public float lifetime = 5.0f;

	void Update()
	{
		lifetime = lifetime - Game.IFps;
        if (lifetime < 0)
        {
            // destroy current node with its properties and components
			node.DeleteLater();
        }
	}
}

// MyComponent.cs

/* .. */
public class MyComponent : Component
{
	
	void Update()
	{
		if (/* a reason to die */)
		{
			LifetimeController lc = node.AddComponent<LifetimeController>();
			lc.lifetime = 2.0f;
		}
	}
}

Instantiating Prefab / Node ReferenceСоздание экземпляра ссылки на префаб / узел#

using UnityEngine;

public class MyComponent : MonoBehaviour
{
public GameObject myPrefab;

void Start()
{
	Instantiate(myPrefab, new Vector3(0, 0, 0), Quaternion.identity);
}
}

/* .. */
public class MyComponent : Component
{
	public AssetLinkNode node_to_spawn;
	
	private void Init()
	{
		Node spawned = node_to_spawn.Load(node.WorldPosition, quat.IDENTITY);

		Node spawned_manually = World.LoadNode("nodes/node_reference.node");
	}
}

/* .. */
public class MyComponent : Component
{
	void Init()
	{
		NodeReference nodeRef = new NodeReference("nodes/node_reference_0.node");
	}
}

You are likely to be accustomed that Unity software enables you to extend the Editor using C# scripts. For this purpose you can use special attributes in your scripts:Вы, вероятно, уже привыкли, что программное обеспечение Unity позволяет расширять редактор с помощью сценариев C#. Для этого вы можете использовать в своих скриптах специальные атрибуты:

• [ExecuteInEditMode] — to execute the script logic during Edit mode, while your application is not running.[ExecuteInEditMode] - для выполнения логики скрипта в режиме Edit, когда ваше приложение не запущено.
• [ExecuteAlways] — to execute the script logic both as part of Play mode and when editing.[ExecuteAlways] - для выполнения логики скрипта как в составе режима Play, так и при редактировании.

For example, this is how you write a component that makes GameObject orient towards the certain point in the scene:Например, вот как вы пишете компонент, который заставляет GameObject повернуться к определенной точке сцены:

//C# Example (LookAtPoint.cs)
using UnityEngine;
[ExecuteInEditMode]
public class LookAtPoint : MonoBehaviour
{
    public Vector3 lookAtPoint = Vector3.zero;

    void Update()
    {
        transform.LookAt(lookAtPoint);
    }
}

UNIGINE doesn't support executing C# logic inside the Editor. Instead, you can write logic in UnigineScript to optimize a project creation process. UnigineScript is available for any programming workflow you have chosen for your project including C# .NET 5.UNIGINE не поддерживает выполнение логики C# внутри редактора. Вместо этого вы можете написать логику в UnigineScript для оптимизации процесса создания проекта. UnigineScript доступен для любого подхода к программированию, который вы выбрали для своего проекта, включая C# .NET 5.

There are two methods to add a script to the project:Есть два способа добавить скрипт в проект :

• By creating a World script. Perform the following steps:Создав скрипт World . Выполните следующие шаги:

  1. Create a .usc script asset.

     

     Создайте ресурс сценария .usc.

     

  2. Write logic. If necessary, add a condition checking if the Editor is loaded:Напишите логику. При необходимости добавьте проверку условия, если редактор загружен:

     Исходный код (UnigineScript)

     #include <core/unigine.h>
     vec3 lookAtPoint = vec3_zero;
     Node node;
     int init() {
     	node = engine.world.getNodeByName("material_ball");
     	return 1;
     }
     
     int update() {
     	if(engine.editor.isLoaded())
     		node.worldLookAt(lookAtPoint);
     	return 1;
     }

  3. Select the current world and specify the world script for it. Click Apply and reload the world.Выберите текущий мир и укажите для него сценарий мира. Нажмите Apply и перезагрузите мир.

     

  4. Check the Console window for errors.Проверьте окно Console на наличие ошибок.

  After that the script logic will be executed in both Editor and application.После этого логика скрипта будет выполняться как в редакторе, так и в приложении.

• By using WorldExpression. For the same purpose you can use a built-in WorldExpression node executing scripts when added to the world:Используя WorldExpression . С той же целью вы можете использовать встроенный узел WorldExpression, выполняющий скрипты при добавлении в мир:

  1. Click Create -> Logic -> Expression and place the new WorldExpression node in the world.Щелкните Create -> Logic -> Expression и поместите новый узел WorldExpression в мир.

  2. Write logic in UnigineScript in the Source field:Запишите логику в UnigineScript в поле Source:

     Исходный код (UnigineScript)

     {
     vec3 lookAtPoint = vec3_zero;
     Node node = engine.world.getNodeByName("my_node");
     node.worldLookAt(lookAtPoint);
     }

  3. Check the Console window for errors.Проверьте окно Console на наличие ошибок.
  4. The logic will be executed immediately.Логика будет выполнена немедленно.

In addition to collision detection, Unity Collider component is accountable for being Trigger that is executed when one collider enters the space of another.В дополнение к обнаружению столкновений, компонент Unity Collider отвечает за то, что он является Trigger, который выполняется, когда один коллайдер входит в пространство другого.

public class MyComponent : MonoBehaviour
{
    void Start()
    {
        collider.isTrigger = true;
    }
    void OnTriggerEnter(Collider other)
    {
        // ...
    }
    void OnTriggerExit(Collider other)
    {
        // ...
    }
}

In UNIGINE, Trigger is a special built-in node that raises events in certain situations:В UNIGINE Trigger - это специальный встроенный узел, который вызывает события в определенных ситуациях:

• NodeTrigger fires callbacks when the Trigger node is enabled or the Trigger node position has changed.NodeTrigger запускает функции обратного вызова, когда узел Trigger включается или узел Trigger изменяет свое положение.
• WorldTrigger fires callbacks when any node (collider or not) gets inside or outside of it.WorldTrigger запускает функции обратного вызова, когда любой узел (коллайдер или нет) входит в объем триггера или же выходит из него.

• PhysicalTrigger fires callbacks when physical objects get inside or outside of it.PhysicalTrigger запускает функции обратного вызова, когда физические объекты получают входят в объем триггера или же выходят из него.

  Примечание

  PhysicalTrigger does not handle collision events, for that purpose Bodies and Joints provide their own events.PhysicalTrigger не обрабатывает события столкновения, для этой цели у тел (bodies) и сочленений (joints) есть свои собственные события.

WorldTriger is the most common type that can be used in gameplay. Here is an example on how to use it:WorldTriger - наиболее распространенный тип, который можно использовать в игровом процессе. Вот пример того, как его использовать:

/* .. */
class MyComponent : Component
{
	WorldTrigger trigger;

	void enter_callback(Node incomer)
	{
		Log.Message("\n{0} has entered the trigger space\n", incomer.Name);
	}

	void Init()
	{
		trigger = node as WorldTrigger;
		if(trigger != null)
		{
			trigger.AddEnterCallback(enter_callback);
			trigger.AddLeaveCallback( leaver => Log.Message("{0} has left the trigger space", leaver.Name));
		}
	}
}

Unity Conventional Game Input:Unity Обычный игровой ввод:

public class MyPlayerController : MonoBehaviour
{
    void Update()
    {
        if (Input.GetButtonDown("Fire"))
        {
            // ...
        }
        float horizontal = Input.GetAxis("Horizontal");
        float vertical = Input.GetAxis("Vertical");
        // ...
    }
}

UNIGINE:

/* .. */
class MyPlayerController : Component
{
    void Update()
    {
		if(Input.IsMouseButtonDown(Input.MOUSE_BUTTON.LEFT))
		{
			Log.Message("Left mouse button was clicked at {0}\n", Input.MouseCoord);
		}

		if (Input.IsKeyDown(Input.KEY.Q) && !Unigine.Console.Activity)
		{
			Log.Message("Q was pressed and the Console is not active.\n");
			App.Exit();
		}
    }
}

You can also use the ControlsApp class to handle control bindings. To configure the bindings, open the Controls settings:Вы также можете использовать класс ControlsApp для обработки привязок элементов управления. Чтобы настроить привязки, откройте настройки Controls:

/* .. */
class MyPlayerController : Component
{
    void Init()
	{
		// remapping states to keys and buttons
		ControlsApp.SetStateKey(Controls.STATE_FORWARD, 'w');
		ControlsApp.SetStateKey(Controls.STATE_BACKWARD, 's');
		ControlsApp.SetStateKey(Controls.STATE_MOVE_LEFT, 'a');
		ControlsApp.SetStateKey(Controls.STATE_MOVE_RIGHT, 'd');
		ControlsApp.SetStateButton(Controls.STATE_JUMP, App.BUTTON_LEFT);
	}
	void Update()
	{
		if (ControlsApp.ClearState(Controls.STATE_FORWARD) != 0)
		{
			Log.Message("FORWARD key pressed\n");
		}
		else if (ControlsApp.ClearState(Controls.STATE_BACKWARD) != 0)
		{
			Log.Message("BACKWARD key pressed\n");
		}
		else if (ControlsApp.ClearState(Controls.STATE_MOVE_LEFT) != 0)
		{
			Log.Message("MOVE_LEFT key pressed\n");
		}
		else if (ControlsApp.ClearState(Controls.STATE_MOVE_RIGHT) != 0)
		{
			Log.Message("MOVE_RIGHT key pressed\n");
		}
		else if (ControlsApp.ClearState(Controls.STATE_JUMP) != 0)
		{
			Log.Message("JUMP button pressed\n");
		}
	}
}

In Unity software, Physics.Raycast is used. GameObject should have a Collider component attached to take part in raycasting:В программном обеспечении Unity используется Physics.Raycast. GameObject должен иметь прикрепленный компонент Collider для участия в рейкастинге:

using UnityEngine;
public class ExampleClass : MonoBehaviour
{
	public Camera camera;

    void Update()
    {
    	// ignore the 2nd layer
        int layerMask = 1 << 2;
        layerMask = ~layerMask;

        RaycastHit hit;
        Ray ray = camera.ScreenPointToRay(Input.mousePosition);
        if (Physics.Raycast(ray, out hit, Mathf.Infinity, layerMask))
        {
            Debug.DrawRay(transform.position, transform.TransformDirection(Vector3.forward) * hit.distance, Color.yellow);
            Debug.Log("Did Hit");
        }
        else
        {
            Debug.DrawRay(transform.position, transform.TransformDirection(Vector3.forward) * 1000, Color.white);
            Debug.Log("Did not Hit");
        }
    }
}

In UNIGINE the same is handled by Intersections:В UNIGINE то же самое реализовано с использованием пересечений (intersections) :

/* .. */
class IntersectionExample : Component
{
	void Init()
	{
		Visualizer.Enabled = true;
	}
    void Update()
    {
    	ivec2 mouse = Input.MouseCoord;
		float length = 100.0f;
		vec3 start = Game.Player.WorldPosition;
		vec3 end = start + new vec3(Game.Player.GetDirectionFromScreen(mouse.x, mouse.y)) * length;

		// ignore surfaces that have certain bits of the Intersection mask enabled
		int mask = ~(1 << 2 | 1 << 4);

		WorldIntersectionNormal intersection = new WorldIntersectionNormal();

		Unigine.Object obj = World.GetIntersection(start, end, mask, intersection);

		if (obj)
		{
			vec3 point = intersection.Point;
			vec3 normal = intersection.Normal;
			Visualizer.RenderVector(point, point + normal, vec4.ONE);
			Log.Message("Hit {0} at {1}\n", obj.Name, point);
		}
	}
}