punkfuncgames/floatingtext-module

FloatingTextModule Reference

Package: com.punkfuncgames.floatingtext | Define: PUNKFUNC_FLOATING_TEXT Location: Packages/com.punkfuncgames.floatingtext/Runtime/PunkFuncGames.FloatingText/ Namespace: PunkFuncGames.FloatingText

Spawning Floating Text

Publish a FloatingTextEvent via MessagePipe — the FloatingTextService handles pooling and display.

Simple Factory

_publisher.Publish(FloatingTextEvent.Simple(position, "+100 Gold", Color.yellow));

Builder Pattern (full control)

_publisher.Publish(new FloatingTextEvent.Builder(position, "+500")
    .WithColor(Color.green)
    .WithDuration(1.5f)
    .WithMoveDistance(2f)
    .WithDirection(Vector3.up)
    .WithScaleMultiplier(1.5f)
    .WithRotation(new Vector3(0, 0, 15))
    .WithRotationAnimation(true)
    .Build());

Direct Spawn (via service interface)

_floatingTextService.Spawn(FloatingTextEvent.Simple(position, "Direct"));

IFloatingTextService : IService, IDisposable

Interface: IFloatingTextService (in Service/IFloatingTextService.cs) Implementation: FloatingTextService (in Service/FloatingTextService.cs)

| Member | Type | Description | |--------|------|-------------| | ActiveCount | ReadOnlyReactiveProperty<int> | Currently active floating texts | | PoolSize | ReadOnlyReactiveProperty<int> | Number of pooled (inactive) views | | IsInitialized | bool | Whether StartAsync has completed | | Spawn(FloatingTextEvent) | void | Manually spawn (ignored if not initialized) |

Implements: IAsyncStartable — StartAsync(CancellationToken) subscribes to events and prewarms pool

Dependencies (constructor injection):

• ISubscriber<FloatingTextEvent> — event subscription
• IPublisher<FloatingTextSpawnedEvent> — lifecycle: text spawned
• IPublisher<FloatingTextCompletedEvent> — lifecycle: text completed
• IPublisher<FloatingTextPoolExhaustedEvent> — lifecycle: pool full
• FloatingTextConfig — animation/pool config
• FloatingTextView — prefab for instantiation

FloatingTextEvent (readonly struct)

Fields: Position, Text, Color?, SpawnOffset?, SpawnRadius?, Direction?, MoveDistance?, Duration?, EaseType?, Overshoot?, ScaleMultiplier?, PunchStrength?, Rotation?, AnimateRotation?

All nullable fields override config defaults when set.

Lifecycle Events (readonly structs)

| Event | Fields | When Published | |-------|--------|----------------| | FloatingTextSpawnedEvent | Position, Text, ActiveCount | After view gets from pool | | FloatingTextCompletedEvent | Position, Text, Duration | After animation completes | | FloatingTextPoolExhaustedEvent | MaxPoolSize, AttemptedText | When pool is full |

FloatingTextConfig (Config + Data Pattern)

FloatingTextConfig (ScriptableObject): Thin wrapper with public FloatingTextConfigData data; Access fields via _config.data.fieldName.

FloatingTextConfigData ([Serializable] public struct, camelCase fields): 67 serialized fields across categories: Space, Spawn Settings, Movement, Timing, Easing, Scale Animation, Rotation, Fade, Appearance, Pooling.

Enums (in Model/FloatingTextEnums.cs):

• SpawnOffsetMode — None, UnitSphere, CustomPivot
• DirectionMode — Up, Down, Left, Right, Forward, Backward, Random, Custom
• ScaleAnimationMode — None, Smooth, Punch, Elastic, Pop
• RotationMode — None, Fixed, RandomPerSpawn
• SpaceMode — World, Screen

Test creation (no CreateRuntime factory):

FloatingTextConfig config = ScriptableObject.CreateInstance<FloatingTextConfig>();
config.data = new FloatingTextConfigData
{
    duration = 1f,
    moveDistance = 2f,
    defaultColor = Color.white,
    prewarmCount = 5,
    maxPoolSize = 20
};

FloatingTextContext (readonly struct)

Immutable runtime context created via FloatingTextContext.Create(config, evt, random?). Merges config defaults with event overrides and evaluates randomized values at spawn time.

27 fields: Position, Text, Color, SpaceMode, SpawnOffset, Direction, MoveDistance, Duration, EaseType, Overshoot, Amplitude, Period, ScaleMode, ScaleMultiplier, ScaleDuration, PunchStrength, PunchVibrato, PunchElasticity, InitialRotation, AnimateRotation, RotationAnimation, FadeStartTime, FadeDuration, UseGradient, ColorGradient, UseOutline, OutlineColor, OutlineThickness

Animation Strategies (IScaleAnimationStrategy)

• NoneScaleStrategy — no scaling
• SmoothScaleStrategy — Yoyo scale with OutBack ease
• PunchScaleStrategy — DOPunchScale with vibrato
• ElasticScaleStrategy — OutElastic scale up, then ease down
• PopScaleStrategy — fast OutBack pop, slow OutElastic settle

Factory: ScaleAnimationStrategyFactory.Create(ScaleAnimationMode) — returns singleton instances

FloatingTextView (MonoBehaviour)

• Uses DOTween Sequences for movement, scale, rotation, color gradient, fade
• Material instance support for dynamic outline effects
• SetCamera(Camera) — inject camera for screen space mode (falls back to Camera.main)
• Initialize() — setup material instance, cache originals, deactivate
• Play(FloatingTextContext, Action) — run animation, callback on complete
• ResetView() — kill tweens, reset transform/alpha, deactivate
• Supports both World and Screen space positioning

Installer

FloatingTextInstaller.Install(builder, options, config, prefab);

Registers:

• FloatingTextService as IFloatingTextService and self (entry point)
• FloatingTextConfig and FloatingTextView prefab as instances
• MessagePipe brokers: FloatingTextEvent, FloatingTextSpawnedEvent, FloatingTextCompletedEvent, FloatingTextPoolExhaustedEvent

Usage Pattern

public sealed class DamageDisplay : IDisposable
{
    private readonly IPublisher<FloatingTextEvent> _publisher;
    private readonly CompositeDisposable _disposables = new();

    public DamageDisplay(
        IPublisher<FloatingTextEvent> publisher,
        ISubscriber<DamageEvent> damageSubscriber)
    {
        _publisher = publisher;
        damageSubscriber.Subscribe(OnDamage).AddTo(_disposables);
    }

    private void OnDamage(DamageEvent evt)
    {
        _publisher.Publish(new FloatingTextEvent.Builder(evt.Position, $"-{evt.Amount}")
            .WithColor(evt.IsCritical ? Color.red : Color.white)
            .WithScaleMultiplier(evt.IsCritical ? 2f : 1f)
            .Build());
    }

    public void Dispose() => _disposables.Dispose();
}

Test Coverage

EditMode Tests: Packages/com.punkfuncgames.floatingtext/Tests/EditMode/

• FloatingTextEventTests — builder, Simple(), ToBuilder(), nulls, fluent chaining
• FloatingTextContextTests — config defaults, event overrides, direction modes, spawn offsets, random seed, fade/scale calculations, outline/gradient
• FloatingTextServiceConstructorTests — null guards, initial state
• FloatingTextLifecycleEventTests — struct fields for Spawned, Completed, PoolExhausted
• IFloatingTextServiceTests — interface contracts
• ScaleAnimationStrategyTests — factory, singleton instances, strategy behavior

PlayMode Tests: Packages/com.punkfuncgames.floatingtext/Tests/PlayMode/

• FloatingTextServiceTests — async init, pool prewarm, event processing, pool limits, active count tracking, dispose cleanup
• FloatingTextViewTests — initialize, SetCamera, Play (text/color/position/alpha), ResetView, inactive callback
• FloatingTextInstallerTests — DI registration for service interface, config, prefab, all event brokers