C#

This guide explains how to integrate Zephyr’s wind data into your own scripts using the ZephyrWind API.

The examples below demonstrate how to retrieve real-time wind vectors, optimize performance with fast calculations, and control global wind properties.

Accessing the Zephyr Wind System

All Zephyr wind data is managed through a singleton instance of ZephyrWind.

using DistantLands.Zephyr;

private ZephyrWind wind;

void Start()
{
    // Cache the Zephyr singleton instance
    wind = ZephyrWind.Instance;
}

Always cache ZephyrWind.Instance in Start() or Awake() instead of calling it repeatedly in Update() for performance reasons.

Getting Wind Data

1. Get Combined Wind at a Position

Retrieves the total combined wind vector at a specific point in world space.

Vector3 windAtPosition = wind.GetWindAtPoint(transform.position);

This value includes:

• Base wind direction

• Gusts

• Fluttering

• Local wind zones

Use this for most general-purpose wind interactions.

---

2. Fast Wind Calculation

Retrieves a simplified wind vector for performance-critical systems.

Vector3 quickWindAtPosition = wind.FastWindCalculation(transform.position);

This method skips localized wind zones for faster calculations, making it ideal for:

• Particle systems

• Far-distance vegetation

• Large-scale environmental effects

---

3. Get Individual Wind Components

Separates the wind into its individual components for more control or debugging.

wind.GetWindComponentsAtPoint(transform.position, 
    out Vector3 combinedWind, 
    out Vector3 baseWind, 
    out Vector3 windFromGusting, 
    out Vector3 windFromFluttering, 
    out Vector3 windFromWindZones);

Outputs:

Variable	Description
combinedWind	Total combined wind at the point.
baseWind	The base directional wind component.
windFromGusting	Short-term gust variation.
windFromFluttering	Small, fast oscillations for detail motion.
windFromWindZones	Localized wind influences from placed Wind Zones.

---

Controlling Global Wind

You can override Zephyr’s global wind settings at runtime for dynamic weather systems or player-triggered events.

Set Target Direction

wind.TargetDirection = new Vector3(0, 0, 1);

Sets the world-space direction Zephyr’s wind system will gradually move toward.

---

Set Target Strength

wind.targetWindStrength = 5;

Sets the target wind strength, on a 0–5 scale:

Value	Description
0	No wind
1	Light breeze
2	Moderate wind
3	Strong wind
4	Heavy gusts
5	Violent storm

Zephyr will smoothly interpolate toward this target over time.

---

Example Script

using UnityEngine;
using DistantLands.Zephyr;

public class GrabZephyrWind : MonoBehaviour
{
    private ZephyrWind wind;

    void Start()
    {
        wind = ZephyrWind.Instance;
    }

    void Update()
    {
        // Get total wind at this position
        Vector3 windAtPosition = wind.GetWindAtPoint(transform.position);

        // Fast, optimized wind (no wind zones)
        Vector3 quickWindAtPosition = wind.FastWindCalculation(transform.position);

        // Get all wind components
        wind.GetWindComponentsAtPoint(transform.position,
            out Vector3 combinedWind,
            out Vector3 baseWind,
            out Vector3 gustWind,
            out Vector3 flutterWind,
            out Vector3 windzonesWind);

        // Modify global wind
        wind.TargetDirection = Vector3.forward;
        wind.targetWindStrength = 5;
    }
}

---

Performance Tips

• Use FastWindCalculation() for background effects or systems that don’t require per-zone accuracy.

• Cache ZephyrWind.Instance to avoid repeated singleton lookups.

• Avoid querying wind every frame for static objects — sample once and reuse.

---

See Also

• Wind Manager

• Effect Listeners