Triggers and your events — IngevoraMirage

Triggers and your eventsA trigger is a rule with two parts: when an event happens, do one or more actions. Face lenses and screen effects both use triggers, and an item can have up to 32 of them.Triggers are data, not code. A published lens or effect is a manifest and its images. It never contains a script, so your app never runs code that comes from IngevoraMirage.Add a trigger

Choose Add trigger in the Triggers panel.

Pick the Event source and the Event name.

Set the first action: its type, and the layer or clip it acts on. Add action adds more.

Each action offers only the layers it can work on.Events

Event source

Event names

Face lenses

Screen effects

Lifecycle

lens.started

Yes

—

Lifecycle

effect.started, effect.ended

—

Yes

Face signal

mouth.open, smile, blink, brows.raised, head.tilt

Yes

—

Host event

Any name your app chooses

Yes

Face signalsEach face signal reads from 0 to 1 on every frame:

mouth.open — how far the lips are apart.

smile — how far the corners of the mouth have widened.

blink — how far the eyes have closed.

brows.raised — how high the brows are above the eyes.

head.tilt — how far the head leans to either side; 1 at 30 degrees or more.

A face trigger fires when its signal rises to the threshold, which is 0.5 unless you tick Custom threshold and set your own between 0 and 1. After it fires, the signal must fall below the threshold minus 0.1 before the trigger can fire again. There is no timer. While no face is tracked, face triggers wait, and they are ready again when a face comes back.Show face signals, under the face viewer, shows the live values while you choose a threshold.Lifecycle eventslens.started fires once, on a face lens's first frame. effect.started fires at time 0 of a screen effect, and effect.ended at its end. Actions on effect.ended have no visible result, because nothing draws after the end.Your app's eventsA host event is a name your app sends while a lens or effect runs, such as round.start or level.complete. IngevoraMirage defines how events work; you choose the names. A name starts with a lowercase letter and uses only lowercase letters, digits, ., _ and -, up to 64 characters in all.

An event applies on the next frame.

An event sent before the lens or effect has started, or after it has ended, is dropped. It is never queued.

An event that no trigger listens to is ignored.

Agree on the names with your developers. The studio can't know which events your app really sends.Actions

Action

Works on

What it does

Show

Any layer

Makes the layer visible.

Hide

Any layer

Hides it. Hiding particles clears them and stops new ones; hiding a motion stops it. A hidden sprite keeps playing unseen.

Play sprite

Animated sprite, full-screen sprite, sprite

Shows the layer and plays it from its first frame, restarting it if it is playing.

Emit particles

Face particles, particles

Shows the layer and throws Count particles at once. Any beyond Max particles alive are dropped.

Run motion

Motion (screen effects only)

Shows the motion and runs it from the start, restarting it if it is running.

Play animation

A keyframe clip

Shows the clip's layer and plays the clip from the start, replacing any clip playing on that layer.

When one event matches several triggers, they run in list order, and each trigger's actions run in order. Later actions win: a Show followed by a Hide on the same frame leaves the layer hidden.Try triggers in the studio

The toolbar's Fire event menu lists the events your triggers listen to. A face signal needs a tracked face; the studio sets it to 1 for one frame so the trigger fires.

Type any name in the Host event box and choose Send.

Restart plays the item from the start, so lens.started or effect.started fires again.

On a phone, the Test on your phone page has a button for each host event the lens uses.

Face lenses and Screen effects — the layers actions work on.

Keyframe animation — clips for Play animation.