Block Category/Name

Function/Notes

Options

3D Animation

To use these blocks, import an FBX file and create a new prefab to spawn.

Pause Animation

Pauses animation and does not rewind.

Stop Animation

Stops and rewinds to the beginning of the animation. Displays the last frame until triggered to play again.

Play Animation

Plays the animation.

Wrap Modes:

-Default/Clamp/Once: plays once from beginning and stops, triggering the output.

-Loop - plays and starts over from the beginning. Never triggers the output.

-Ping Pong - plays back and forth. Never triggers the output.

-Clamp Forever: Always in a play state. Never triggers the output.

Speed:

1 is normal speed forwards. -1 is normal speed backwards.

Set Time Animation

Sets the time, in seconds, in the animation. When End is checked it sets the time to the very end of the animation.

Audio

Import a .mp3 or .wav and bundle them using Audio Tools > Audio Objects from Selection.

Play Audio

Plays the audio file.

-Loop – on/off

-Times – how many times the audio will loop before it stops and activates the output

Pause Audio

Pauses the audio so it will resume from the same spot when played.

Stop Audio

Stops and rewinds the audio.

Wait until end of loop will wait until the cycle is finished before stopping and triggering the output.

Bend Audio

Bends the pitch of the audio.

-Pitch – change the number to change the pitch

-Duration – how many seconds it takes to bend

Pan Audio

Pans the audio left and right (stereo sound – headphones only on devices with one speaker, such as iPhone, iPad, etc).

-Pan: -1 is full left, 0 is center, 1 is full right

Change Audio Volume

Changes the audio volume.

-Volume – 0 is silent, 1 is full volume

-Duration – in seconds, how long it takes for the volume to change

Data

Set Integer

Sets and saves a variable.

-Key: a global (across the entire app), unique name for your variable

-Integer: the variable you want to save. The current number can have the following operations applied:

-Set

-Add

-Multiply

-Divide

-Mod: Modulos: gives you the remainder

-Power: Exponential

-Random

Test Integer

A trigger to test for a previously set integer. Similar to an “if” statement.

-Key: a global (across the entire app), unique name for your variable

-Integer: the variable you want to save. The current number can have the following operations applied:

-Equal

-Not Equal

-Greater Than

-Less Than

-GreaterThanOrEqual

-LessThanOrEqual

-Mod: checks if the integer is perfectly divisible by the number

Display

Auto Orientation

Check the orientations you want to be available.

Screen Orientation

Sets default orientation.

Camera Follow

Parents the camera to an object you select.

-Speed – default is .25 – how fast the camera follows the object – 1 or higher.

Camera Properties

Set the properties for your camera.

-Orthograph – when checked, uses an orthographic camera. When unchecked, uses a perspective 3D camera.

- Size/Field of Vision – default is set to iPad at 5.12 (aspect ratio for camera)

-Background Color – sets the background color of the camera

Editing

Debug Trigger

Like a root trigger – you can fire it whenever you want while playing.

Helpful to test OnMessage blocks and other blocks that usually don’t fire without outside input.

Note

Allows you to type a note.

Checking debug will show the note in the Console when it’s triggered.

Global

Load Chapter

Won’t work until you’ve circulated to the device.

Select a chapter to load from the dropdown menu.

Load Scene

Type a Unity scene name to load.

Typing “AgencyBrowser” will go back to the agency app screen when circulating.

Open URL

Launches Safari (and suspends your app) on the device and opens the specified URL.

Activate the text field by clicking in the blank space in the block. Make sure to include “http://”

Logic

Action State

Acts as an enable/disable for anything connected to the output.

Default state is enable – check “disable” to change.

On Disable

A trigger that fires when the block connected to the input has been disabled.

Materials

Color

Acts just like an event tree version of the timeline Color block.

-Type

-Instant

-Per Frame - additive

-Per Second - additive

-Over Frames

-Over Seconds

-Color

-Recursive – changes children as well

-Duration – in frames or seconds

-Adjust the curve to change animation style

Objects

Movers

Position, Rotate and Scale

Act like the separate elements of a motion block in the timeline.

-Type

-Instant

-Per Frame - additive

-Per Second - additive

-Over Frames

-Over Seconds

-Always use Self space (as opposed to world)

-Set From Current – sets the values to the object’s current position

-Relative space will move the object the specified amount from its current position when triggered. Absolute will move the object to the same spot in space every time.

-Duration – in seconds or frames

-Curve – adjust the animation style

Page Control

Actions

Load Page(s)

Loads multiple pages.

-Click Add to add a page to the list after selecting it.

-Auto Start will play the page automatically once it’s loaded. The output will not trigger until all pages are loaded.

-Synchronize  will wait until all pages in the list are loaded before playing them.

Unload Page(s)

Unloads multiple pages.

Click Add to add a page to the list after selecting it.

Message Page(s)

Messages multiple pages.

-Click Add to add a page to the list after selecting it.

-Type a unique text string in the text field. This is sent as a message to the pages in the list. Messages are received using On Message blocks.

-Special built-in messages:

-enablePanelMarker

-disablePanelMarker

Set Play State(s)

Plays or pauses multiple pages.

Click Add to add a page to the list after selecting it.

Pause Page

Pauses the current page.

Unpause Page

Unpauses the current page.

Combined

Panel Marker

Used in books with comic-style panels to easily navigate forwards and backwards. Swipe is on by default – swiping left goes backwards and swiping right goes forward.

-First object: tap to jump to the “return” frame

-Second object: tap to unpause the page

-Trigger: frame number where the page pauses and activates the objects specified. Also activates the output.

-Return: frame number to jump back to when tapping the first specified object.

-Disable swipe: check to disable the swipe feature.

-After tapping either object, anything connected to the output is disabled.

Triggers

Wait

Delays the output by the specified amount.

Choose frames or seconds.

On Enter

Acts like a root trigger. Activates when the cursor in the timeline enters the event block.

On Exit

Activates when the cursor in the timeline leaves the event block.

On Message

Activates when the specified message is received.

Percent Trigger

Sets a trigger in the event block at the point you specify on the slider. Will scale with the event block.

Watch the page editor as you drag the slider to see the placement.

Root

Fires when the cursor enters the event block.

On Frame

Fires when the specified frame number is reached in the timeline.

SoundFX

No longer in use. Use Audio blocks instead.

Sprites

Pause Sprite

Pauses the sprite, and on Play will continue from the same spot.

Play Sprite

Plays the specified sprite.

-Loop

-Frames per Second

-Anim: name of the animation clip to play (if there are multiple)

Stop Sprite

Stops the sprite and rewinds it. Play will start it from the beginning.

Touch

Multitouch

Manipulatable Object

Makes the specified object manipulatable by touch on the device.

-Limits

-choose an axis to lock an axis (so you can’t move in that axis)

-set a min and max position so the object can’t be dragged outside of those boundaries (for example, the screen boundaries)

-Rotate and Scale – when checked, allows two finger manipulation

-Physics

-Velocity – lets the object keep moving after a drag, as if it had friction, until it stops. Set Multiplier to change the amount – 1 will make it go forever until it hits the limit, higher than one will accelerate after it’s let go, less than 1 will slow it down. Should never be negative.

-Spring – puts the object back in its original position after it’s let go. Multiplier is how fast it bounces back.

-Spring Back in Bounds – if object is dragged past its limits, it will bounce back. Set axes you want to spring in. Multiplier is how much it will bounce.

-Ignore Depth – when checked, will allow the object to be picked even when behind other objects

OnTouchUp

Triggers when the user’s finger leaves the screen after a touch on the specified object.

-Tap Count – how many times touched before it fires

-Threshold – how many pixels a finger is allowed to move before it’s counted as a movement rather than a tap – default is 20

-Ignore Depth – when checked, will allow a touch even if the specified object is behind other objects

-First Touch Only – only records the first finger put on the screen – if more are added, it will ignore all but the first – uncheck to allow multiple touches to register at once

On Swipe

Activates when the user swipes in the specified direction.

Video

Play Video

Plays the specified video.

Make sure the video file is a supported type and compression format for your target device, and that it is saved in the Story folder with your .dats, .flow, etc.

WebPlayer

Play Video on Object

Plays a video on an object in Web Player only.

Stop Video on Object

Stops a video on an object in Web Player only.

Legacy

NOTE: If you are not already using these blocks in your projects, do NOT use them! They are included for backwards compatibility ONLY.

Unsupported

NOTE: These blocks were created for specific projects. Feel free to experiment with them, but they may be buggy for your purposes and will not be supported.