How to edit Key Points: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{editor location|cinematics|left panel=The Cinematic to edit}}
{{editor location|cinematics|left panel=The Cinematic to edit}}
The most important property of a cinematic is the keypoints. These determine the path that the cinematic takes. Additionally, a keypoint can also determine what happens when that point is reached, such as the activation of [[event]]s or the display of text. A cinematic should have at least 1 keypoint.
Cinematics are defined by keypoints. These determine the path that the cinematic takes. Additionally, a keypoint can also determine what happens when that point is reached, such as the activation of [[event]]s or the display of text. A cinematic should have at least 1 keypoint.


====Creating and removing keypoints====
====Creating and removing keypoints====
Line 25: Line 25:
{{editor location|cinematic keypoint}}
{{editor location|cinematic keypoint}}
[[File:Cinematics-keypoint-right.jpg|frame|left|The right panel allows you to edit the properties of keypoints.]]
[[File:Cinematics-keypoint-right.jpg|frame|left|The right panel allows you to edit the properties of keypoints.]]
When a specific keypoint is selected, you are able to edit its properties in the [[right panel]]. Upon selecting a keypoint, the camera will also orient itself to that keypoint, by assuming its location and direction. The camera will match the exact orientation the camera will have as it passes this keypoint when the cinematic is played.
When a specific keypoint is selected, you are able to edit its properties in the [[right panel]]. Selecting a keypoint automatically aligns the camera with that point's location and direction. This matches the exact orientation the camera will have when passing this keypoint during playback.


=====Description=====
=====Description=====
[[File:Cinematics-keypoint-right-description.jpg|frame|right|The field for the "description".]]
[[File:Cinematics-keypoint-right-description.jpg|frame|right|The field for the "description".]]
: ''The description of the keypoint. This is the text that will be displayed to the user when the cinematic reaches this point. You can change this by altering the text in the text area.''
: ''The description of the keypoint. This is the text that will be displayed to the user when the cinematic reaches this point.''
<br clear=right>
<br clear=right>


=====Paused=====
=====Paused=====
[[File:Cinematics-keypoint-right-paused.jpg|frame|right|The checkbox for pausing at this keypoint.]]
[[File:Cinematics-keypoint-right-paused.jpg|frame|right|The checkbox for pausing at this keypoint.]]
: ''The pausing property of the keypoint. When this checkbox is checked, the cinematic will pause when it reaches this point, until the user chooses to continue. You can change this setting by checking or unchecking the checkbox.''
: ''The pausing property of the keypoint. When this checkbox is checked, the cinematic will pause when it reaches this point, until the user chooses to continue.''
<br clear=right>
<br clear=right>


=====Time=====
=====Time=====
[[File:Cinematics-keypoint-right-time.jpg|frame|right|The field for the "time".]]
[[File:Cinematics-keypoint-right-time.jpg|frame|right|The field for the "time".]]
: ''The time in seconds to travel between this keypoint and the next keypoint. A lower number means the camera will travel faster between the two key points. You can change the time by altering the number in the text field. Note that if the provided time would cause the camera to move too quickly, the time is automatically adjusted to a higher number so that the camera travels with a lower speed.''
: ''The time in seconds to travel between this keypoint and the next keypoint. A lower number means the camera will travel faster between the two keypoints. You can change the time by altering the number in the text field. If the specified time is too short, it will be automatically increased to limit the camera's speed.''
<br clear=right>
<br clear=right>


Line 50: Line 50:
[[File:Cinematics-keypoint-right-events.jpg|frame|right|The list of event bundles fired by the keypoint.]]
[[File:Cinematics-keypoint-right-events.jpg|frame|right|The list of event bundles fired by the keypoint.]]
: ''Main article: [[Event]]s
: ''Main article: [[Event]]s
: ''The [[Event Bundle|event bundle]]s which will be fired when this keypoint is reached. This allows [[event]]s to take place at given points during a cinematic. Event bundles can be added by selecting an event bundle from the dropdown box and selecting "Add". An event bundle can be removed by selecting the event bundle in the list, and selecting "Remove Event Bundle".''
: ''The [[Event Bundle|event bundle]]s which will be fired when this keypoint is reached. This allows [[event]]s to take place at given points during a cinematic. Add event bundles using the dropdown and "Add" button; remove them by selecting a bundle and clicking "Remove Event Bundle"''
<br clear=right>
<br clear=right>


=====Edit Camera Position=====
=====Edit Camera Position=====
[[File:Cinematics-keypoint-right-edit.jpg|frame|right|The button to edit the camera position.]]
[[File:Cinematics-keypoint-right-edit.jpg|frame|right|The button to edit the camera position.]]
: ''This button activates the camera editing mode. In this mode, it is possible to move the camera, and orient it in any direction. The camera's location and orientation can then be stored as the orientation for the camera when the cinematic reaches the selected keypoint.''
: ''This button activates the camera editing mode. In this mode, it is possible to move the camera, and orient it in any direction. This saves the current location and orientation for when the cinematic reaches this keypoint.''
<br clear=right>
<br clear=right>
<br clear=all>
<br clear=all>
Line 65: Line 65:
*  [[How to edit Cinematics]]
*  [[How to edit Cinematics]]
*  [[How to edit the Camera Position]]
*  [[How to edit the Camera Position]]
*  [[How to couple cinematics to stakeholders]]
*  [[How to couple Cinematics to Stakeholders]]
|api=
* [[Api session event editor cinematic add keypoint event bundle]]
* [[Api session event editor cinematic remove keypoint event bundle]]
}}
}}
{{Editor tools nav}}
{{Editor tools nav}}


[[Category:How-to's]]
[[Category:How-to's]]

Latest revision as of 14:02, 10 July 2026

Editor → Tools (Ribbon tab) → Cinematics (Ribbon bar)

Cinematics are defined by keypoints. These determine the path that the cinematic takes. Additionally, a keypoint can also determine what happens when that point is reached, such as the activation of events or the display of text. A cinematic should have at least 1 keypoint.

Creating and removing keypoints

The left panel also allows you to select keypoints of cinematics.
How to add a new keypoint:
  1. Select "Visuals" in the ribbon header.
  2. Select "Cinematics" in the ribbon bar.
  3. Select the cinematic you want to add the keypoint to in the Left Panel.
  4. If there is already at least one keypoint present, select the keypoint you want the new keypoint to be added after.
  5. Select "Add Key Point".
How to remove an existing keypoint:
  1. Select "Visuals" in the ribbon header.
  2. Select "Cinematics" in the ribbon bar.
  3. Select the cinematic from which you wish to remove a keypoint.
  4. Select the keypoint you wish to remove.
  5. Select "Remove".


Changing keypoint properties

Editor → Tools (Ribbon tab) → Cinematics (Ribbon bar) → The Cinematic to edit (Left panel) → The keypoint to edit (Sub-option)
The right panel allows you to edit the properties of keypoints.

When a specific keypoint is selected, you are able to edit its properties in the right panel. Selecting a keypoint automatically aligns the camera with that point's location and direction. This matches the exact orientation the camera will have when passing this keypoint during playback.

Description
The field for the "description".
The description of the keypoint. This is the text that will be displayed to the user when the cinematic reaches this point.


Paused
The checkbox for pausing at this keypoint.
The pausing property of the keypoint. When this checkbox is checked, the cinematic will pause when it reaches this point, until the user chooses to continue.


Time
The field for the "time".
The time in seconds to travel between this keypoint and the next keypoint. A lower number means the camera will travel faster between the two keypoints. You can change the time by altering the number in the text field. If the specified time is too short, it will be automatically increased to limit the camera's speed.


Time Slider
The slider for setting the camera's time for the current keypoint.
This slider allows you to see the orientation and location of the camera at any time between this keypoint and the next. By moving the slider, you move the camera between the selected keypoint and the next by the same relative amount. This is not an editable property.


Fired Events
The list of event bundles fired by the keypoint.
Main article: Events
The event bundles which will be fired when this keypoint is reached. This allows events to take place at given points during a cinematic. Add event bundles using the dropdown and "Add" button; remove them by selecting a bundle and clicking "Remove Event Bundle"


Edit Camera Position
The button to edit the camera position.
This button activates the camera editing mode. In this mode, it is possible to move the camera, and orient it in any direction. This saves the current location and orientation for when the cinematic reaches this keypoint.