Sandstorm.c

См. документацию.

/*
    This class serves as the interface to the Sandstorm weather phenomenom.
    Control of the phenomenon is driven by the server and replicated to all clients.
    The controller instance can be obtained via `Weather::GetSandstorm`.
*/
class SandstormController
{
    private void SandstormController()  { /*Disallowed.*/ }
    private void ~SandstormController() { /*Disallowed.*/ }
    /*
        \brief Starts the sandstorm, gathering its full magnitude over `duration` seconds.
               The sandstorm must be inactive prior to this call and this call is Server-only!
        \param duration The duration in seconds over which the sandstorm gradually fades
                        in towards its target intensity.
    */
    proto native bool Start(float duration, bool calledByWeather);
    proto native void Stop(float duration, bool calledByWeather);
    proto native bool IsActive();
    proto native vector GetDirection();
    proto native bool IsPositionAtEnd();
    proto native vector GetPosition();
    proto native float GetSpeed();
    proto native float GetRemainingMovementDuration();
    proto native float GetPointOnEdge(vector worldPosition, out vector outPosition);
    proto native float GetIntensity(vector worldPosition);
    float GetIntensityForPlayer(Man player);
    proto native float GetMagnitude();
    protected event void OnStart(bool continuedSession, bool calledByWeather = false)
    {
        // Forward the callback to WorldData
        if (g_Game.IsServer())
        {
            GetGame().GetMission().GetWorldData().WeatherSandstormStart(continuedSession);
        }
    }

    protected event void OnUpdate(float deltaTime)
    {
    }

    protected event void OnStop(bool calledByWeather = false)
    {
        // Forward the callback to WorldData
        if (g_Game.IsServer())
        {
            GetGame().GetMission().GetWorldData().WeatherSandstormStop(calledByWeather);
        }
    }

    private static event typename GetScriptedType()
    {
        //
        // The following class is present in module 4_World and
        // hence its typename cannot be used directly in 3_Game.
        //
        string className = "ScriptedSandstormController";
        return className.ToType();
    }
};
 
typedef SandstormController Sandstorm;