Story components let the designer add cut scenes to the game. These can be full screen animations, or simply a character in the corner giving tutorial tips. They can be triggered at any time, be any length, and let players choose between rewards.
Stories are triggered when they are added to a players inventory. They are only ever added and triggered once, and the system records when a story is watched to completion. If a story is ended prematurely (i.e. by a refresh) it will show the story again on launch until it has been completed.
Common places to trigger stories might be
If multiple stories are triggered and added to the player’s inventory, they will be queued up and played in sequence. If any game component tips need to be played (shown in a toast), they will wait until the story playback is complete before showing.
This lets you specify if how square, landscape or portrait your cut scene should render, and when set, will crop anything that doesn’t fit in that window.
For example, if you set this to 0.5, your cutscene will render in a full height portrait window that is half as wide as it is tall. Anything outside that window will not be shown.
If you build your cutscene for mobile, you could leave aspect ratio unset, but then viewing it on desktop, you might end up seeing visual elements animate beyond the edges, which might look weird.
Our suggestion is to use an aspect ratio of 1 and keep the core subject matter centered in the middle portrait area. This way relevant elements will be visible on mobile, and on desktop you’ll have a larger cutscene than a tall rectangle.
This prevents the player from interacting with game components while the cut scene is playing. A tutorial clip with a mentor in the corner telling you what to do would likely leave this unset. A true cutscene, meant to be watch to completion without distraction, would check this on.
Lets you add a solid color or semi-transparent overlay over the background. Use this is you don’t want to add a full size image as a background, and want to hide or fade the game scene to focus attention on your story elements.