Difference between revisions of "DOMWater"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMWater class)
 
(Documentation for the DOMWater class)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
* '''Inherits class: [[DOMTransform]]'''
+
Represents a body of water
 +
 
 +
*'''Inherits class: [[DOMTransform]]'''
 +
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMWater Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 +
{{#ifexist:DOMWater Remarks|{{:DOMWater Remarks}}|}}
 +
 
 
===Properties===
 
===Properties===
 
:{{CSharp|string AttachToBone {get; set;} }}
 
:{{CSharp|string AttachToBone {get; set;} }}
 +
:{{CSharp|float Cutoff {get; set;} }}
 +
::
 +
::The alpha cutoff of the water texture
  
−
:{{CSharp|bool Clickable {get; set;} }}
+
:{{CSharp|Color32 DeepWaterColor {get; set;} }}
 +
::
 +
::Deep water color
  
−
:{{CSharp|ResourceValue Cursor {get; set;} }}
+
:{{CSharp|float Density {get; set;} }}
 +
::
 +
::Water density
  
−
:{{CSharp|Single CursorDistance {get; set;} }}
+
:{{CSharp|float DepthTransparency {get; set;} }}
 +
::
 +
::How far can you see underwater
  
−
:{{CSharp|bool CursorMiddleHotspot {get; set;} }}
+
:{{CSharp|float DistanceTilingFade {get; set;} }}
 +
::
 +
::Rate at which tiling texture fades out
 +
 
 +
:{{CSharp|float Distortion {get; set;} }}
 +
::
 +
::Distortion factor of the water
 +
 
 +
:{{CSharp|bool EnableReflections {get; set;} }}
 +
::
 +
::Toggle to enable/disable reflections on water
  
 
:{{CSharp|bool ExcludeTransform {get; set;} }}
 
:{{CSharp|bool ExcludeTransform {get; set;} }}
 +
:{{CSharp|float Fade {get; set;} }}
 +
::
 +
::Fade
  
−
:{{CSharp|bool Selectable {get; set;} }}
+
:{{CSharp|float FoamBlend {get; set;} }}
 +
::
 +
::Blending factor on foam
  
−
:{{CSharp|Single SX {get; set;} }}
+
:{{CSharp|Color32 FoamColor {get; set;} }}
 +
::
 +
::Blending factor on foam
  
−
:{{CSharp|Single SY {get; set;} }}
+
:{{CSharp|float FoamContrast {get; set;} }}
 +
::
 +
::Contrast factor on foam
  
−
:{{CSharp|Single SZ {get; set;} }}
+
:{{CSharp|float FoamDistFade {get; set;} }}
 +
::
 +
::Distance at which foam fades out
  
−
:{{CSharp|bool Targetable {get; set;} }}
+
:{{CSharp|float FoamDistFalloff {get; set;} }}
 +
::
 +
::Distance at which foam falls off
  
 +
:{{CSharp|float FoamIntensity {get; set;} }}
 +
::
 +
::Intensity of the foam
 +
 +
:{{CSharp|float FoamSpeed {get; set;} }}
 +
::
 +
::Speed of the foam animation
 +
 +
:{{CSharp|ResourceValue FoamTexture {get; set;} }}
 +
::
 +
::Texture to use for the foam
 +
 +
:{{CSharp|float FoamTiling {get; set;} }}
 +
::
 +
::Tiling factor of the foam
 +
 +
:{{CSharp|float FoamVisibility {get; set;} }}
 +
::
 +
::Alpha of the foam
 +
 +
:{{CSharp|Color32 FogColor {get; set;} }}
 +
::
 +
::Blending factor on foam
 +
 +
:{{CSharp|float FogDistance {get; set;} }}
 +
::
 +
::Fog distance of the scene where colors fade out
 +
 +
:{{CSharp|float FogFade {get; set;} }}
 +
::
 +
::Fog fade rate
 +
 +
:{{CSharp|float Gloss {get; set;} }}
 +
::
 +
::Gloss of the water
 +
 +
:{{CSharp|float LargeWaveRefraction {get; set;} }}
 +
::
 +
::Refraction index for Large Waves
 +
 +
:{{CSharp|float LargeWavesSpeed {get; set;} }}
 +
::
 +
::Speed for Large Waves
 +
 +
:{{CSharp|ResourceValue LargeWavesTexture {get; set;} }}
 +
::
 +
::Texture for Large Waves
 +
 +
:{{CSharp|float LargeWavesTiling {get; set;} }}
 +
::
 +
::Tiling factor for Large Waves
 +
 +
:{{CSharp|float LightWrapping {get; set;} }}
 +
::
 +
::Light wrapping
 +
 +
:{{CSharp|float LongTilingDistance {get; set;} }}
 +
::
 +
::Long distance for tiling
 +
 +
:{{CSharp|Color32 MainColor {get; set;} }}
 +
::
 +
::Main water color
 +
 +
:{{CSharp|float MediumTilingDistance {get; set;} }}
 +
::
 +
::Medium distance for tiling
 +
 +
:{{CSharp|float MediumWaveRefraction {get; set;} }}
 +
::
 +
::Refraction index for Medium Waves
 +
 +
:{{CSharp|float MediumWavesSpeed {get; set;} }}
 +
::
 +
::Speed for Medium Waves
 +
 +
:{{CSharp|ResourceValue MediumWavesTexture {get; set;} }}
 +
::
 +
::Texture for Medium Waves
 +
 +
:{{CSharp|float MediumWavesTiling {get; set;} }}
 +
::
 +
::Tiling factor for Medium Waves
 +
 +
:{{CSharp|float ReflectionIntensity {get; set;} }}
 +
::
 +
::Reflection Intensity
 +
 +
:{{CSharp|float ShoreFade {get; set;} }}
 +
::
 +
::Shore Fade
 +
 +
:{{CSharp|float ShoreTransparency {get; set;} }}
 +
::
 +
::Shore Transparency
 +
 +
:{{CSharp|float SmallWaveRefraction {get; set;} }}
 +
::
 +
::Refraction index for Small Waves
 +
 +
:{{CSharp|float SmallWavesSpeed {get; set;} }}
 +
::
 +
::Speed for Small Waves
 +
 +
:{{CSharp|ResourceValue SmallWavesTexture {get; set;} }}
 +
::
 +
::Texture for Small Waves
 +
 +
:{{CSharp|float SmallWavesTiling {get; set;} }}
 +
::
 +
::Tiling factor for Small Waves
 +
 +
:{{CSharp|float Specular {get; set;} }}
 +
::
 +
::Specularity
 +
 +
:{{CSharp|float SX {get; set;} }}
 +
:{{CSharp|float SY {get; set;} }}
 +
:{{CSharp|float SZ {get; set;} }}
 
:{{CSharp|long TransformParentID {get; set;} }}
 
:{{CSharp|long TransformParentID {get; set;} }}
 +
:{{CSharp|bool UsePlane {get; set;} }}
 +
::
 +
::Toggle to enable/disable reflections on water
  
 
:{{CSharp|Point3D Velocity {get; set;} }}
 
:{{CSharp|Point3D Velocity {get; set;} }}
 +
:{{CSharp|float WaveBlend {get; set;} }}
 +
::
 +
::Wave Blend
 +
 +
:{{CSharp|float WaveFade {get; set;} }}
 +
::
 +
::Wave Fade
 +
 +
===Constructors===
 +
:{{CSharp|DOMWater()}}
 +
::
 +
::Constructs a new DOMWater with default settings
 +
 +
:{{CSharp|DOMWater(DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMWater, adding children at the same time
  
−
:{{CSharp|DOMWaterType WaterType {get; set;} }}
+
:{{CSharp|DOMWater(string title, DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMWater, setting a title and adding children at the same time
  
−
===Methods===
+
__NOTOC____NOEDITSECTION__

Latest revision as of 19:21, 5 February 2019

Represents a body of water

Remarks [edit]

Properties

string AttachToBone {get; set;}
float Cutoff {get; set;}
The alpha cutoff of the water texture
Color32 DeepWaterColor {get; set;}
Deep water color
float Density {get; set;}
Water density
float DepthTransparency {get; set;}
How far can you see underwater
float DistanceTilingFade {get; set;}
Rate at which tiling texture fades out
float Distortion {get; set;}
Distortion factor of the water
bool EnableReflections {get; set;}
Toggle to enable/disable reflections on water
bool ExcludeTransform {get; set;}
float Fade {get; set;}
Fade
float FoamBlend {get; set;}
Blending factor on foam
Color32 FoamColor {get; set;}
Blending factor on foam
float FoamContrast {get; set;}
Contrast factor on foam
float FoamDistFade {get; set;}
Distance at which foam fades out
float FoamDistFalloff {get; set;}
Distance at which foam falls off
float FoamIntensity {get; set;}
Intensity of the foam
float FoamSpeed {get; set;}
Speed of the foam animation
ResourceValue FoamTexture {get; set;}
Texture to use for the foam
float FoamTiling {get; set;}
Tiling factor of the foam
float FoamVisibility {get; set;}
Alpha of the foam
Color32 FogColor {get; set;}
Blending factor on foam
float FogDistance {get; set;}
Fog distance of the scene where colors fade out
float FogFade {get; set;}
Fog fade rate
float Gloss {get; set;}
Gloss of the water
float LargeWaveRefraction {get; set;}
Refraction index for Large Waves
float LargeWavesSpeed {get; set;}
Speed for Large Waves
ResourceValue LargeWavesTexture {get; set;}
Texture for Large Waves
float LargeWavesTiling {get; set;}
Tiling factor for Large Waves
float LightWrapping {get; set;}
Light wrapping
float LongTilingDistance {get; set;}
Long distance for tiling
Color32 MainColor {get; set;}
Main water color
float MediumTilingDistance {get; set;}
Medium distance for tiling
float MediumWaveRefraction {get; set;}
Refraction index for Medium Waves
float MediumWavesSpeed {get; set;}
Speed for Medium Waves
ResourceValue MediumWavesTexture {get; set;}
Texture for Medium Waves
float MediumWavesTiling {get; set;}
Tiling factor for Medium Waves
float ReflectionIntensity {get; set;}
Reflection Intensity
float ShoreFade {get; set;}
Shore Fade
float ShoreTransparency {get; set;}
Shore Transparency
float SmallWaveRefraction {get; set;}
Refraction index for Small Waves
float SmallWavesSpeed {get; set;}
Speed for Small Waves
ResourceValue SmallWavesTexture {get; set;}
Texture for Small Waves
float SmallWavesTiling {get; set;}
Tiling factor for Small Waves
float Specular {get; set;}
Specularity
float SX {get; set;}
float SY {get; set;}
float SZ {get; set;}
long TransformParentID {get; set;}
bool UsePlane {get; set;}
Toggle to enable/disable reflections on water
Point3D Velocity {get; set;}
float WaveBlend {get; set;}
Wave Blend
float WaveFade {get; set;}
Wave Fade

Constructors

DOMWater()
Constructs a new DOMWater with default settings
DOMWater(DOMObject[] children)
Constructs a new DOMWater, adding children at the same time
DOMWater(string title, DOMObject[] children)
Constructs a new DOMWater, setting a title and adding children at the same time


Retrieved from "http://wiki.virtualworldweb.com/index.php?title=DOMWater&oldid=5342"