Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Pause

Pauses the looping animation on the referenced wire without clearing it.
Read time 2 minutesLast updated 6 days ago

Definition

Pause(WireReference)

Pauses the looping animation on the referenced wire without clearing it.
public void Pause(WireReference wire)

Parameters

wire

WireReference
The wire on which to pause the animation.

Remarks

Freezes the flow animation at its current segment offset while keeping the wire's customization (dashed pattern, width, opacity) applied. Call GraphMotion.Play again on the same wire to resume the animation at the requested speed. If you pause a wire that has no active animation there is no visible effect. Throws ArgumentException when 
wire
doesn't correspond to a wire in the current Context.

Examples

WireReference wire = context.GetWireReference(outputPortID, inputPortID);context.Motion.Play(wire);// Pause the animation; call Play again to resume.context.Motion.Pause(wire);

Pause(TransitionReference)

Pauses the looping animation on the referenced transition without clearing it.
public void Pause(TransitionReference transition)

Parameters

transition

TransitionReference
The transition on which to pause the animation.

Remarks

Freezes the animation at its current segment offset while keeping the transition's customization (dashed pattern, width, opacity, color) applied. Call GraphMotion.Play again on the same transition to resume the animation at the requested speed. Throws ArgumentException when 
transition
doesn't correspond to a transition in the current Context.

Examples

TransitionReference transitionRef = context.GetTransitionReference(transitionID);context.Motion.Play(transitionRef);// Pause the animation; call Play again to resume.context.Motion.Pause(transitionRef);

Pause(NodeReference)

Pauses the looping animation on the referenced node's accent without hiding it.
public void Pause(NodeReference node)

Parameters

node

NodeReference
The node on which to pause the animation.

Remarks

Freezes the looping animation at its current state and keeps the accent bar visible on the node. Call GraphMotion.Play again to resume the animation at the requested speed. If you pause a node that has no active animation there is no visible effect. Throws ArgumentException when 
node
doesn't correspond to a node in the current Context.

Examples

NodeReference nodeRef = context.GetNodeReference(nodeID);context.Motion.Play(nodeRef, animationSpeed: 1f);// Pause the animation; call Play again to resume.context.Motion.Pause(nodeRef);

Pause(StateReference)

Pauses the looping animation on the referenced state's accent without hiding it.
public void Pause(StateReference state)

Parameters

state

StateReference
The state on which to pause the animation.

Remarks

Freezes the looping animation at its current state and keeps the accent bar visible on the state. Call GraphMotion.Play again to resume the animation at the requested speed. If you pause a state that has no active animation there is no visible effect. Throws ArgumentException when 
state
doesn't correspond to a state in the current Context.

Examples

StateReference stateRef = context.GetStateReference(stateID);context.Motion.Play(stateRef, animationSpeed: 1f);// Pause the animation; call Play again to resume.context.Motion.Pause(stateRef);