Changes between Version 4 and Version 5 of Atlas_Manual_Cinematics_Tab

Timestamp:

Jul 18, 2017, 12:45:19 PM (7 years ago)

Author:

Vladislav Belov

Comment:

--

Atlas_Manual_Cinematics_Tab

@@ -8 +8 @@
 ''The contents of the Cinematics Tab''
 
-== ==
+== Terms ==
+Currently all paths contain position and target nodes. **Position nodes** - nodes used for the camera position. **Target nodes** - nodes used for the camera focus position. In other words the camera looks from positions to targets. **Delta time** - time between nodes which the camera spends to move from the one node to the other node.
 
 == Common settings ==
@@ -40 +41 @@
 
 To delete a node, select it and press a `Delete` button on the keyboard. If you need to edit delta times, you could edit nodes in a map XML file (atlas editing for delta times will be added later).
+
+== Triggers and on fly paths ==
+
+Currently there is no way to run a cinema path without a trigger script, but this possibility will be added later.
+
+=== Run cinema path ===
+
+An example trigger script to run an existing cinema path in 5 seconds:
+
+{{{
+#!javascript
+Trigger.prototype.StartCutscene = function(data)
+{
+        var cmpCinemaManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_CinemaManager);
+        // We should work only with valid components
+        if (!cmpCinemaManager)
+                return;
+        // Add a cinema path with "test" name to the queue
+        cmpCinemaManager.AddCinemaPathToQueue("MyPath");
+        // Start playing the queue
+        cmpCinemaManager.Play();
+};
+
+var cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+cmpTrigger.DoAfterDelay(5000, "StartCutscene", {}); // Delay is set in milliseconds
+}}}
+
+=== Add cinema path in triggers ===
+
+{{{
+#!javascript
+Trigger.prototype.StartCutscene = function(data)
+{
+        var cmpCinemaManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_CinemaManager);
+        // We should work only with valid components
+        if (!cmpCinemaManager)
+                return;
+
+        let pointA = new Vector3D(1, 1, 1);
+        let pointB = new Vector3D(100, 100, 100);
+        let path = {
+                "name": "MyPath",
+                "orientation": "target",
+                "positionNodes": [
+                        {"deltaTime": 0, "position": pointA},
+                        {"deltaTime": 10, "position": pointB}
+                ],
+                "targetNodes": [
+                        {"deltaTime": 0, "position": Vector3D.add(pointA, new Vector3D(10, 10, 0))},
+                        {"deltaTime": 10, "position": Vector3D.add(pointB, new Vector3D(10, 10, 0))}
+                ]
+        };
+
+        // Add the newly created path
+        cmpCinemaManager.AddPath(path);
+        cmpCinemaManager.AddCinemaPathToQueue(path.name);
+
+        // Start playing the queue
+        cmpCinemaManager.Play();
+};
+
+var cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+cmpTrigger.DoAfterDelay(5000, "StartCutscene", {}); // Delay is set in milliseconds
+}}}