Interface IMyWeatherEffects

Namespace: VRage.Game.ModAPI

Assembly: VRage.Game.dll

Syntax

public interface IMyWeatherEffects

Properties

FogAtmoOverride

Gets or sets sector's FogAtmo. When value is null, used default sector value

Declaration

Nullable<float> FogAtmoOverride { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

FogColorOverride

Gets or sets sector's FogColor. When value is null, used default sector value

Declaration

Nullable<Vector3> FogColorOverride { get; set; }

Property Value

Type	Description
System.Nullable<Vector3>

FogDensityOverride

Gets or sets sector's FogDensity. When value is null, used default sector value

Declaration

Nullable<float> FogDensityOverride { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

FogMultiplierOverride

Gets or sets sector's FogMultiplier. When value is null, used default sector value

Declaration

Nullable<float> FogMultiplierOverride { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

FogSkyboxOverride

Gets or sets sector's FogSkybox. When value is null, used default sector value

Declaration

Nullable<float> FogSkyboxOverride { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

ParticleDirectionOverride

Gets or sets sector's ParticleDirection. When value is null, used default sector value

Declaration

Nullable<MatrixD> ParticleDirectionOverride { get; set; }

Property Value

Type	Description
System.Nullable<MatrixD>

ParticleVelocityOverride

Gets or sets sector's ParticleVelocity. When value is null, used default sector value

Declaration

Nullable<Vector3> ParticleVelocityOverride { get; set; }

Property Value

Type	Description
System.Nullable<Vector3>

SunIntensityOverride

Gets or sets sector's SunIntensity. When value is null, used default sector value

Declaration

Nullable<float> SunIntensityOverride { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

Methods

CreateLightning(Vector3D, MyObjectBuilder_WeatherLightning, Boolean)

Creates lightning

Declaration

void CreateLightning(Vector3D position, MyObjectBuilder_WeatherLightning lightning, bool doDamage = true)

Parameters

Type	Name	Description
Vector3D	position	World position. Side effect: changing Position
MyObjectBuilder_WeatherLightning	lightning	Settings of lightning
System.Boolean	doDamage	When false - changing ExplosionRadius to zero

GetOxygenMultiplier(Vector3D)

Gets weather oxygen multiplier at world coordinates

Declaration

float GetOxygenMultiplier(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World coordinates

Returns

Type	Description
System.Single	Oxygen multiplier

GetOxygenMultiplier(Vector3D, MyObjectBuilder_WeatherEffect)

Gets weather oxygen multiplier in point for provided weather

Declaration

float GetOxygenMultiplier(Vector3D position, MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
Vector3D	position	World coordinates
MyObjectBuilder_WeatherEffect	weatherEffect	Object builder of exact weather

Returns

Type	Description
System.Single	Oxygen multiplier

GetSolarMultiplier(Vector3D)

Gets solar multiplier at world coordinates

Declaration

float GetSolarMultiplier(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World coordinates

Returns

Type	Description
System.Single	Solar multiplier

GetSolarMultiplier(Vector3D, MyObjectBuilder_WeatherEffect)

Gets weather solar multiplier in point for provided weather

Declaration

float GetSolarMultiplier(Vector3D position, MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
Vector3D	position	World coordinates
MyObjectBuilder_WeatherEffect	weatherEffect	Object builder of exact weather

Returns

Type	Description
System.Single	Solar multiplier

GetTemperatureMultiplier(Vector3D)

Gets weather temperature multiplier in point for provided weather

Declaration

float GetTemperatureMultiplier(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World coordinates

Returns

Type	Description
System.Single	Temperature multiplier

GetTemperatureMultiplier(Vector3D, MyObjectBuilder_WeatherEffect)

Gets weather temperature multiplier in point for provided weather

Declaration

float GetTemperatureMultiplier(Vector3D position, MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
Vector3D	position	World coordinates
MyObjectBuilder_WeatherEffect	weatherEffect	Object builder of exact weather

Returns

Type	Description
System.Single	Temperature multiplier

GetWeather(Vector3D)

Gets weather name at provided position

Declaration

string GetWeather(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World position

Returns

Type	Description
System.String	SubtypeName of weather

GetWeather(Vector3D, out MyObjectBuilder_WeatherEffect)

Gets object builder of weather at provided position

Declaration

bool GetWeather(Vector3D position, out MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
Vector3D	position	World position
MyObjectBuilder_WeatherEffect	weatherEffect	Object builder

Returns

Type	Description
System.Boolean	True there is weather in that point

GetWeatherIntensity(Vector3D)

Gets weather intensity at world coordinates

Declaration

float GetWeatherIntensity(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World coordinates

Returns

Type	Description
System.Single	Weather intensity

GetWeatherIntensity(Vector3D, MyObjectBuilder_WeatherEffect)

Gets weather intensity in point for provided weather

Declaration

float GetWeatherIntensity(Vector3D position, MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
Vector3D	position	World coordinates
MyObjectBuilder_WeatherEffect	weatherEffect	Object builder of exact weather

Returns

Type	Description
System.Single	Weather intensity

GetWeatherPlanetData()

Gets list (not a copy) of all weathers that are currently running

Declaration

List<MyObjectBuilder_WeatherPlanetData> GetWeatherPlanetData()

Returns

Type	Description
System.Collections.Generic.List<MyObjectBuilder_WeatherPlanetData>	List of weathers

GetWindMultiplier(Vector3D)

Gets weather temperature multiplier in point for provided weather

Declaration

float GetWindMultiplier(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World coordinates

Returns

Type	Description
System.Single	Wind multiplier

GetWindMultiplier(Vector3D, MyObjectBuilder_WeatherEffect)

Gets weather solar multiplier in point for provided weather

Declaration

float GetWindMultiplier(Vector3D position, MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
Vector3D	position	World coordinates
MyObjectBuilder_WeatherEffect	weatherEffect	Object builder of exact weather

Returns

Type	Description
System.Single	Wind multiplier

RemoveWeather(MyObjectBuilder_WeatherEffect)

Removes weather by its object builder

Declaration

void RemoveWeather(MyObjectBuilder_WeatherEffect weatherEffect)

Parameters

Type	Name	Description
MyObjectBuilder_WeatherEffect	weatherEffect

RemoveWeather(Vector3D)

Removes weather at specific location

Declaration

bool RemoveWeather(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position	World position

Returns

Type	Description
System.Boolean	True if removed weather

SetWeather(String, Single, Nullable<Vector3D>, Boolean, Vector3D, Int32, Single)

Sets weather

Declaration

bool SetWeather(string weatherEffect, float radius, Nullable<Vector3D> weatherPosition, bool verbose, Vector3D velocity, int length = 0, float intensity = 1F)

Parameters

Type	Name	Description
System.String	weatherEffect	SubtypeName of weather
System.Single	radius	Radius of weather
System.Nullable<Vector3D>	weatherPosition	World position of weather center
System.Boolean	verbose	When true, errors would be typing into the chat
Vector3D	velocity	Velocity of weather effect
System.Int32	length	Duration of weather effect
System.Single	intensity	Intensity of weather effect

Returns

Type	Description
System.Boolean	True when weather was created