SCRIPTING API / Rendering and effects / Ocean

Ocean

Script access to an entity's Ocean: waves, colours and surface quality.

Kindclass

NamespaceKroys.EngineScripting

Members112

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example Ocean.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class Ocean

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Ocean component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the Ocean component's Enabled value of the entity.

methodstatic

#public static void SetEnabled(Entity e, bool value)

Sets the Ocean component's Enabled value on the entity.

methodstatic

#public static bool IsVisible(Entity e)

Reads the Ocean component's Visible value of the entity.

methodstatic

#public static void SetVisible(Entity e, bool value)

Sets the Ocean component's Visible value on the entity.

methodstatic

#public static bool IsCausticsOnSurfaceEnabled(Entity e)

Reads the Ocean component's Caustics On Surface Enabled value of the entity.

methodstatic

#public static void SetCausticsOnSurface(Entity e, bool value)

Sets the Ocean component's Caustics On Surface value on the entity.

methodstatic

#public static OceanSurfaceQuality GetQuality(Entity e)

Reads the Ocean component's Quality value of the entity.

methodstatic

#public static void SetQuality(Entity e, OceanSurfaceQuality value)

Sets the Ocean component's Quality value on the entity.

methodstatic

#public static OceanSurfacePreset GetPreset(Entity e)

Reads the Ocean component's Preset value of the entity.

methodstatic

#public static void SetPreset(Entity e, OceanSurfacePreset value)

Sets the Ocean component's Preset value on the entity.

methodstatic

#public static WaterBodyMode GetBodyMode(Entity e)

Reads the Ocean component's Body Mode value of the entity.

methodstatic

#public static void SetBodyMode(Entity e, WaterBodyMode value)

Sets the Ocean component's Body Mode value on the entity.

methodstatic

#public static float GetVolumeDepth(Entity e)

Reads the Ocean component's Volume Depth value of the entity.

methodstatic

#public static void SetVolumeDepth(Entity e, float value)

Sets the Ocean component's Volume Depth value on the entity.

methodstatic

#public static float GetRenderDistance(Entity e)

Reads the Ocean component's Render Distance value of the entity.

methodstatic

#public static void SetRenderDistance(Entity e, float value)

Sets the Ocean component's Render Distance value on the entity.

methodstatic

#public static float GetWindSpeed(Entity e)

Reads the Ocean component's Wind Speed value of the entity.

methodstatic

#public static void SetWindSpeed(Entity e, float value)

Sets the Ocean component's Wind Speed value on the entity.

methodstatic

#public static float GetFetch(Entity e)

Reads the Ocean component's Fetch value of the entity.

methodstatic

#public static void SetFetch(Entity e, float value)

Sets the Ocean component's Fetch value on the entity.

methodstatic

#public static float GetWaveHeight(Entity e)

Reads the Ocean component's Wave Height value of the entity.

methodstatic

#public static void SetWaveHeight(Entity e, float value)

Sets the Ocean component's Wave Height value on the entity.

methodstatic

#public static float GetSwell(Entity e)

Reads the Ocean component's Swell value of the entity.

methodstatic

#public static void SetSwell(Entity e, float value)

Sets the Ocean component's Swell value on the entity.

methodstatic

#public static float GetChoppiness(Entity e)

Reads the Ocean component's Choppiness value of the entity.

methodstatic

#public static void SetChoppiness(Entity e, float value)

Sets the Ocean component's Choppiness value on the entity.

methodstatic

#public static float GetDirectionalSpread(Entity e)

Reads the Ocean component's Directional Spread value of the entity.

methodstatic

#public static void SetDirectionalSpread(Entity e, float value)

Sets the Ocean component's Directional Spread value on the entity.

methodstatic

#public static float GetShortWaveStrength(Entity e)

Reads the Ocean component's Short Wave Strength value of the entity.

methodstatic

#public static void SetShortWaveStrength(Entity e, float value)

Sets the Ocean component's Short Wave Strength value on the entity.

methodstatic

#public static float GetShortWaveScale(Entity e)

Reads the Ocean component's Short Wave Scale value of the entity.

methodstatic

#public static void SetShortWaveScale(Entity e, float value)

Sets the Ocean component's Short Wave Scale value on the entity.

methodstatic

#public static float GetAnimationSpeed(Entity e)

Reads the Ocean component's Animation Speed value of the entity.

methodstatic

#public static void SetAnimationSpeed(Entity e, float value)

Sets the Ocean component's Animation Speed value on the entity.

methodstatic

#public static float GetReflectivity(Entity e)

Reads the Ocean component's Reflectivity value of the entity.

methodstatic

#public static void SetReflectivity(Entity e, float value)

Sets the Ocean component's Reflectivity value on the entity.

methodstatic

#public static float GetRoughness(Entity e)

Reads the Ocean component's Roughness value of the entity.

methodstatic

#public static void SetRoughness(Entity e, float value)

Sets the Ocean component's Roughness value on the entity.

methodstatic

#public static float GetFresnelPower(Entity e)

Reads the Ocean component's Fresnel Power value of the entity.

methodstatic

#public static void SetFresnelPower(Entity e, float value)

Sets the Ocean component's Fresnel Power value on the entity.

methodstatic

#public static float GetRefractionStrength(Entity e)

Reads the Ocean component's Refraction Strength value of the entity.

methodstatic

#public static void SetRefractionStrength(Entity e, float value)

Sets the Ocean component's Refraction Strength value on the entity.

methodstatic

#public static float GetNormalStrength(Entity e)

Reads the Ocean component's Normal Strength value of the entity.

methodstatic

#public static void SetNormalStrength(Entity e, float value)

Sets the Ocean component's Normal Strength value on the entity.

methodstatic

#public static float GetFoamIntensity(Entity e)

Reads the Ocean component's Foam Intensity value of the entity.

methodstatic

#public static void SetFoamIntensity(Entity e, float value)

Sets the Ocean component's Foam Intensity value on the entity.

methodstatic

#public static float GetFoamThreshold(Entity e)

Reads the Ocean component's Foam Threshold value of the entity.

methodstatic

#public static void SetFoamThreshold(Entity e, float value)

Sets the Ocean component's Foam Threshold value on the entity.

methodstatic

#public static float GetShoreFoamIntensity(Entity e)

Reads the Ocean component's Shore Foam Intensity value of the entity.

methodstatic

#public static void SetShoreFoamIntensity(Entity e, float value)

Sets the Ocean component's Shore Foam Intensity value on the entity.

methodstatic

#public static float GetShoreFoamDistance(Entity e)

Reads the Ocean component's Shore Foam Distance value of the entity.

methodstatic

#public static void SetShoreFoamDistance(Entity e, float value)

Sets the Ocean component's Shore Foam Distance value on the entity.

methodstatic

#public static float GetFoamScale(Entity e)

Reads the Ocean component's Foam Scale value of the entity.

methodstatic

#public static void SetFoamScale(Entity e, float value)

Sets the Ocean component's Foam Scale value on the entity.

methodstatic

#public static float GetUnderwaterVisibility(Entity e)

Reads the Ocean component's Underwater Visibility value of the entity.

methodstatic

#public static void SetUnderwaterVisibility(Entity e, float value)

Sets the Ocean component's Underwater Visibility value on the entity.

methodstatic

#public static float GetUnderwaterTintStrength(Entity e)

Reads the Ocean component's Underwater Tint Strength value of the entity.

methodstatic

#public static void SetUnderwaterTintStrength(Entity e, float value)

Sets the Ocean component's Underwater Tint Strength value on the entity.

methodstatic

#public static float GetUnderwaterBrightness(Entity e)

Reads the Ocean component's Underwater Brightness value of the entity.

methodstatic

#public static void SetUnderwaterBrightness(Entity e, float value)

Sets the Ocean component's Underwater Brightness value on the entity.

methodstatic

#public static float GetUnderwaterContrast(Entity e)

Reads the Ocean component's Underwater Contrast value of the entity.

methodstatic

#public static void SetUnderwaterContrast(Entity e, float value)

Sets the Ocean component's Underwater Contrast value on the entity.

methodstatic

#public static float GetAbsorptionStrength(Entity e)

Reads the Ocean component's Absorption Strength value of the entity.

methodstatic

#public static void SetAbsorptionStrength(Entity e, float value)

Sets the Ocean component's Absorption Strength value on the entity.

methodstatic

#public static float GetUnderwaterDistortionStrength(Entity e)

Reads the Ocean component's Underwater Distortion Strength value of the entity.

methodstatic

#public static void SetUnderwaterDistortionStrength(Entity e, float value)

Sets the Ocean component's Underwater Distortion Strength value on the entity.

methodstatic

#public static float GetUnderwaterDistortionScale(Entity e)

Reads the Ocean component's Underwater Distortion Scale value of the entity.

methodstatic

#public static void SetUnderwaterDistortionScale(Entity e, float value)

Sets the Ocean component's Underwater Distortion Scale value on the entity.

methodstatic

#public static float GetUnderwaterDistortionSpeed(Entity e)

Reads the Ocean component's Underwater Distortion Speed value of the entity.

methodstatic

#public static void SetUnderwaterDistortionSpeed(Entity e, float value)

Sets the Ocean component's Underwater Distortion Speed value on the entity.

methodstatic

#public static float GetWaterlineSoftness(Entity e)

Reads the Ocean component's Waterline Softness value of the entity.

methodstatic

#public static void SetWaterlineSoftness(Entity e, float value)

Sets the Ocean component's Waterline Softness value on the entity.

methodstatic

#public static float GetCausticsIntensity(Entity e)

Reads the Ocean component's Caustics Intensity value of the entity.

methodstatic

#public static void SetCausticsIntensity(Entity e, float value)

Sets the Ocean component's Caustics Intensity value on the entity.

methodstatic

#public static float GetCausticsScale(Entity e)

Reads the Ocean component's Caustics Scale value of the entity.

methodstatic

#public static void SetCausticsScale(Entity e, float value)

Sets the Ocean component's Caustics Scale value on the entity.

methodstatic

#public static float GetCausticsSpeed(Entity e)

Reads the Ocean component's Caustics Speed value of the entity.

methodstatic

#public static void SetCausticsSpeed(Entity e, float value)

Sets the Ocean component's Caustics Speed value on the entity.

methodstatic

#public static float GetGodRaysIntensity(Entity e)

Reads the Ocean component's God Rays Intensity value of the entity.

methodstatic

#public static void SetGodRaysIntensity(Entity e, float value)

Sets the Ocean component's God Rays Intensity value on the entity.

methodstatic

#public static float GetGodRaysScale(Entity e)

Reads the Ocean component's God Rays Scale value of the entity.

methodstatic

#public static void SetGodRaysScale(Entity e, float value)

Sets the Ocean component's God Rays Scale value on the entity.

methodstatic

#public static float GetEnvironmentReflectionIntensity(Entity e)

Reads the Ocean component's Environment Reflection Intensity value of the entity.

methodstatic

#public static void SetEnvironmentReflectionIntensity(Entity e, float value)

Sets the Ocean component's Environment Reflection Intensity value on the entity.

methodstatic

#public static float GetEnvironmentReflectionBlur(Entity e)

Reads the Ocean component's Environment Reflection Blur value of the entity.

methodstatic

#public static void SetEnvironmentReflectionBlur(Entity e, float value)

Sets the Ocean component's Environment Reflection Blur value on the entity.

methodstatic

#public static float GetScreenSpaceReflectionIntensity(Entity e)

Reads the Ocean component's Screen Space Reflection Intensity value of the entity.

methodstatic

#public static void SetScreenSpaceReflectionIntensity(Entity e, float value)

Sets the Ocean component's Screen Space Reflection Intensity value on the entity.

methodstatic

#public static float GetSunSpecularIntensity(Entity e)

Reads the Ocean component's Sun Specular Intensity value of the entity.

methodstatic

#public static void SetSunSpecularIntensity(Entity e, float value)

Sets the Ocean component's Sun Specular Intensity value on the entity.

methodstatic

#public static float GetReflectionHighlightLimit(Entity e)

Reads the Ocean component's Reflection Highlight Limit value of the entity.

methodstatic

#public static void SetReflectionHighlightLimit(Entity e, float value)

Sets the Ocean component's Reflection Highlight Limit value on the entity.

methodstatic

#public static float GetCausticsSharpness(Entity e)

Reads the Ocean component's Caustics Sharpness value of the entity.

methodstatic

#public static void SetCausticsSharpness(Entity e, float value)

Sets the Ocean component's Caustics Sharpness value on the entity.

methodstatic

#public static float GetCausticsDepthFade(Entity e)

Reads the Ocean component's Caustics Depth Fade value of the entity.

methodstatic

#public static void SetCausticsDepthFade(Entity e, float value)

Sets the Ocean component's Caustics Depth Fade value on the entity.

methodstatic

#public static Vector3 GetShallowColor(Entity e)

Reads the Ocean component's Shallow Color value of the entity.

methodstatic

#public static void SetShallowColor(Entity e, Vector3 value)

Sets the Ocean component's Shallow Color value on the entity.

methodstatic

#public static Vector3 GetDeepColor(Entity e)

Reads the Ocean component's Deep Color value of the entity.

methodstatic

#public static void SetDeepColor(Entity e, Vector3 value)

Sets the Ocean component's Deep Color value on the entity.

methodstatic

#public static Vector3 GetFoamColor(Entity e)

Reads the Ocean component's Foam Color value of the entity.

methodstatic

#public static void SetFoamColor(Entity e, Vector3 value)

Sets the Ocean component's Foam Color value on the entity.

methodstatic

#public static Vector3 GetVolumeColor(Entity e)

Reads the Ocean component's Volume Color value of the entity.

methodstatic

#public static void SetVolumeColor(Entity e, Vector3 value)

Sets the Ocean component's Volume Color value on the entity.

methodstatic

#public static Vector3 GetWindDirection(Entity e)

Reads the Ocean component's Wind Direction value of the entity.

methodstatic

#public static void SetWindDirection(Entity e, Vector3 value)

Sets the Ocean component's Wind Direction value on the entity.

methodstatic

#public static Vector3 GetBodySize(Entity e)

Reads the Ocean component's Body Size value of the entity.

methodstatic

#public static void SetBodySize(Entity e, Vector3 value)

Sets the Ocean component's Body Size value on the entity.

methodstatic

#public static Vector3 GetCausticsColor(Entity e)

Reads the Ocean component's Caustics Color value of the entity.

methodstatic

#public static void SetCausticsColor(Entity e, Vector3 value)

Sets the Ocean component's Caustics Color value on the entity.

methodstatic

#public static ulong GetRuntimeMesh(Entity e)

Reads the Ocean component's Runtime Mesh value of the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static bool IsVisible(Entity e)
public static void SetVisible(Entity e, bool value)
public static bool IsCausticsOnSurfaceEnabled(Entity e)
public static void SetCausticsOnSurface(Entity e, bool value)
public static OceanSurfaceQuality GetQuality(Entity e)
public static void SetQuality(Entity e, OceanSurfaceQuality value)
public static OceanSurfacePreset GetPreset(Entity e)
public static void SetPreset(Entity e, OceanSurfacePreset value)
public static WaterBodyMode GetBodyMode(Entity e)
public static void SetBodyMode(Entity e, WaterBodyMode value)
public static float GetVolumeDepth(Entity e)
public static void SetVolumeDepth(Entity e, float value)
public static float GetRenderDistance(Entity e)
public static void SetRenderDistance(Entity e, float value)
public static float GetWindSpeed(Entity e)
public static void SetWindSpeed(Entity e, float value)
public static float GetFetch(Entity e)
public static void SetFetch(Entity e, float value)
public static float GetWaveHeight(Entity e)
public static void SetWaveHeight(Entity e, float value)
public static float GetSwell(Entity e)
public static void SetSwell(Entity e, float value)
public static float GetChoppiness(Entity e)
public static void SetChoppiness(Entity e, float value)
public static float GetDirectionalSpread(Entity e)
public static void SetDirectionalSpread(Entity e, float value)
public static float GetShortWaveStrength(Entity e)
public static void SetShortWaveStrength(Entity e, float value)
public static float GetShortWaveScale(Entity e)
public static void SetShortWaveScale(Entity e, float value)
public static float GetAnimationSpeed(Entity e)
public static void SetAnimationSpeed(Entity e, float value)
public static float GetReflectivity(Entity e)
public static void SetReflectivity(Entity e, float value)
public static float GetRoughness(Entity e)
public static void SetRoughness(Entity e, float value)
public static float GetFresnelPower(Entity e)
public static void SetFresnelPower(Entity e, float value)
public static float GetRefractionStrength(Entity e)
public static void SetRefractionStrength(Entity e, float value)
public static float GetNormalStrength(Entity e)
public static void SetNormalStrength(Entity e, float value)
public static float GetFoamIntensity(Entity e)
public static void SetFoamIntensity(Entity e, float value)
public static float GetFoamThreshold(Entity e)
public static void SetFoamThreshold(Entity e, float value)
public static float GetShoreFoamIntensity(Entity e)
public static void SetShoreFoamIntensity(Entity e, float value)
public static float GetShoreFoamDistance(Entity e)
public static void SetShoreFoamDistance(Entity e, float value)
public static float GetFoamScale(Entity e)
public static void SetFoamScale(Entity e, float value)
public static float GetUnderwaterVisibility(Entity e)
public static void SetUnderwaterVisibility(Entity e, float value)
public static float GetUnderwaterTintStrength(Entity e)
public static void SetUnderwaterTintStrength(Entity e, float value)
public static float GetUnderwaterBrightness(Entity e)
public static void SetUnderwaterBrightness(Entity e, float value)
public static float GetUnderwaterContrast(Entity e)
public static void SetUnderwaterContrast(Entity e, float value)
public static float GetAbsorptionStrength(Entity e)
public static void SetAbsorptionStrength(Entity e, float value)
public static float GetUnderwaterDistortionStrength(Entity e)
public static void SetUnderwaterDistortionStrength(Entity e, float value)
public static float GetUnderwaterDistortionScale(Entity e)
public static void SetUnderwaterDistortionScale(Entity e, float value)
public static float GetUnderwaterDistortionSpeed(Entity e)
public static void SetUnderwaterDistortionSpeed(Entity e, float value)
public static float GetWaterlineSoftness(Entity e)
public static void SetWaterlineSoftness(Entity e, float value)
public static float GetCausticsIntensity(Entity e)
public static void SetCausticsIntensity(Entity e, float value)
public static float GetCausticsScale(Entity e)
public static void SetCausticsScale(Entity e, float value)
public static float GetCausticsSpeed(Entity e)
public static void SetCausticsSpeed(Entity e, float value)
public static float GetGodRaysIntensity(Entity e)
public static void SetGodRaysIntensity(Entity e, float value)
public static float GetGodRaysScale(Entity e)
public static void SetGodRaysScale(Entity e, float value)
public static float GetEnvironmentReflectionIntensity(Entity e)
public static void SetEnvironmentReflectionIntensity(Entity e, float value)
public static float GetEnvironmentReflectionBlur(Entity e)
public static void SetEnvironmentReflectionBlur(Entity e, float value)
public static float GetScreenSpaceReflectionIntensity(Entity e)
public static void SetScreenSpaceReflectionIntensity(Entity e, float value)
public static float GetSunSpecularIntensity(Entity e)
public static void SetSunSpecularIntensity(Entity e, float value)
public static float GetReflectionHighlightLimit(Entity e)
public static void SetReflectionHighlightLimit(Entity e, float value)
public static float GetCausticsSharpness(Entity e)
public static void SetCausticsSharpness(Entity e, float value)
public static float GetCausticsDepthFade(Entity e)
public static void SetCausticsDepthFade(Entity e, float value)
public static Vector3 GetShallowColor(Entity e)
public static void SetShallowColor(Entity e, Vector3 value)
public static Vector3 GetDeepColor(Entity e)
public static void SetDeepColor(Entity e, Vector3 value)
public static Vector3 GetFoamColor(Entity e)
public static void SetFoamColor(Entity e, Vector3 value)
public static Vector3 GetVolumeColor(Entity e)
public static void SetVolumeColor(Entity e, Vector3 value)
public static Vector3 GetWindDirection(Entity e)
public static void SetWindDirection(Entity e, Vector3 value)
public static Vector3 GetBodySize(Entity e)
public static void SetBodySize(Entity e, Vector3 value)
public static Vector3 GetCausticsColor(Entity e)
public static void SetCausticsColor(Entity e, Vector3 value)
public static ulong GetRuntimeMesh(Entity e)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.