File size: 8,045 Bytes
18a519f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | using System;
using UnityEngine;
namespace Unity.VisualScripting
{
/// <summary>
/// Runs a timer and outputs elapsed and remaining measurements.
/// </summary>
[UnitCategory("Time")]
[UnitOrder(7)]
public sealed class Timer : Unit, IGraphElementWithData, IGraphEventListener
{
public sealed class Data : IGraphElementData
{
public float elapsed;
public float duration;
public bool active;
public bool paused;
public bool unscaled;
public Delegate update;
public bool isListening;
}
/// <summary>
/// The moment at which to start the timer.
/// If the timer is already started, this will reset it.
/// If the timer is paused, this will resume it.
/// </summary>
[DoNotSerialize]
public ControlInput start { get; private set; }
/// <summary>
/// Trigger to pause the timer.
/// </summary>
[DoNotSerialize]
public ControlInput pause { get; private set; }
/// <summary>
/// Trigger to resume the timer.
/// </summary>
[DoNotSerialize]
public ControlInput resume { get; private set; }
/// <summary>
/// Trigger to toggle the timer.
/// If it is idle, it will start.
/// If it is active, it will pause.
/// If it is paused, it will resume.
/// </summary>
[DoNotSerialize]
public ControlInput toggle { get; private set; }
/// <summary>
/// The total duration of the timer.
/// </summary>
[DoNotSerialize]
public ValueInput duration { get; private set; }
/// <summary>
/// Whether to ignore the time scale.
/// </summary>
[DoNotSerialize]
[PortLabel("Unscaled")]
public ValueInput unscaledTime { get; private set; }
/// <summary>
/// Called when the timer is started.co
/// </summary>
[DoNotSerialize]
public ControlOutput started { get; private set; }
/// <summary>
/// Called each frame while the timer is active.
/// </summary>
[DoNotSerialize]
public ControlOutput tick { get; private set; }
/// <summary>
/// Called when the timer completes.
/// </summary>
[DoNotSerialize]
public ControlOutput completed { get; private set; }
/// <summary>
/// The number of seconds elapsed since the timer started.
/// </summary>
[DoNotSerialize]
[PortLabel("Elapsed")]
public ValueOutput elapsedSeconds { get; private set; }
/// <summary>
/// The proportion of the duration that has elapsed (0-1).
/// </summary>
[DoNotSerialize]
[PortLabel("Elapsed %")]
public ValueOutput elapsedRatio { get; private set; }
/// <summary>
/// The number of seconds remaining until the timer is elapsed.
/// </summary>
[DoNotSerialize]
[PortLabel("Remaining")]
public ValueOutput remainingSeconds { get; private set; }
/// <summary>
/// The proportion of the duration remaining until the timer is elapsed (0-1).
/// </summary>
[DoNotSerialize]
[PortLabel("Remaining %")]
public ValueOutput remainingRatio { get; private set; }
protected override void Definition()
{
isControlRoot = true;
start = ControlInput(nameof(start), Start);
pause = ControlInput(nameof(pause), Pause);
resume = ControlInput(nameof(resume), Resume);
toggle = ControlInput(nameof(toggle), Toggle);
duration = ValueInput(nameof(duration), 1f);
unscaledTime = ValueInput(nameof(unscaledTime), false);
started = ControlOutput(nameof(started));
tick = ControlOutput(nameof(tick));
completed = ControlOutput(nameof(completed));
elapsedSeconds = ValueOutput<float>(nameof(elapsedSeconds));
elapsedRatio = ValueOutput<float>(nameof(elapsedRatio));
remainingSeconds = ValueOutput<float>(nameof(remainingSeconds));
remainingRatio = ValueOutput<float>(nameof(remainingRatio));
}
public IGraphElementData CreateData()
{
return new Data();
}
public void StartListening(GraphStack stack)
{
var data = stack.GetElementData<Data>(this);
if (data.isListening)
{
return;
}
var reference = stack.ToReference();
var hook = new EventHook(EventHooks.Update, stack.machine);
Action<EmptyEventArgs> update = args => TriggerUpdate(reference);
EventBus.Register(hook, update);
data.update = update;
data.isListening = true;
}
public void StopListening(GraphStack stack)
{
var data = stack.GetElementData<Data>(this);
if (!data.isListening)
{
return;
}
var hook = new EventHook(EventHooks.Update, stack.machine);
EventBus.Unregister(hook, data.update);
data.update = null;
data.isListening = false;
}
public bool IsListening(GraphPointer pointer)
{
return pointer.GetElementData<Data>(this).isListening;
}
private void TriggerUpdate(GraphReference reference)
{
using (var flow = Flow.New(reference))
{
Update(flow);
}
}
private ControlOutput Start(Flow flow)
{
var data = flow.stack.GetElementData<Data>(this);
data.elapsed = 0;
data.duration = flow.GetValue<float>(duration);
data.active = true;
data.paused = false;
data.unscaled = flow.GetValue<bool>(unscaledTime);
AssignMetrics(flow, data);
return started;
}
private ControlOutput Pause(Flow flow)
{
var data = flow.stack.GetElementData<Data>(this);
data.paused = true;
return null;
}
private ControlOutput Resume(Flow flow)
{
var data = flow.stack.GetElementData<Data>(this);
data.paused = false;
return null;
}
private ControlOutput Toggle(Flow flow)
{
var data = flow.stack.GetElementData<Data>(this);
if (!data.active)
{
return Start(flow);
}
else
{
data.paused = !data.paused;
return null;
}
}
private void AssignMetrics(Flow flow, Data data)
{
flow.SetValue(elapsedSeconds, data.elapsed);
flow.SetValue(elapsedRatio, Mathf.Clamp01(data.elapsed / data.duration));
flow.SetValue(remainingSeconds, Mathf.Max(0, data.duration - data.elapsed));
flow.SetValue(remainingRatio, Mathf.Clamp01((data.duration - data.elapsed) / data.duration));
}
public void Update(Flow flow)
{
var data = flow.stack.GetElementData<Data>(this);
if (!data.active || data.paused)
{
return;
}
data.elapsed += data.unscaled ? Time.unscaledDeltaTime : Time.deltaTime;
data.elapsed = Mathf.Min(data.elapsed, data.duration);
AssignMetrics(flow, data);
var stack = flow.PreserveStack();
flow.Invoke(tick);
if (data.elapsed >= data.duration)
{
data.active = false;
flow.RestoreStack(stack);
flow.Invoke(completed);
}
flow.DisposePreservedStack(stack);
}
}
}
|