Difference between revisions of "GetWaterTrait"

From GECK

(Created page with "{{Function |origin = LU |summary = Returns a trait value of a water form. |name = GetWaterTrait |returnType = float |arguments = {{FunctionArgument |Name = waterFor...")
 
 
Line 1: Line 1:
 
{{Function
 
{{Function
  |origin = LU
+
  |origin = JIP
  |summary = Returns a trait value of a water form.
+
  |summary = Returns the value of a numeric trait (determined by <i>traitID</i>) of the specified '''Water Type''' form.
 
  |name = GetWaterTrait
 
  |name = GetWaterTrait
  |returnType = float
+
  |returnType = traitValue:float
 
  |arguments =  
 
  |arguments =  
 
   {{FunctionArgument
 
   {{FunctionArgument
   |Name = waterForm
+
   |Name = waterType
 
   |Type = ref
 
   |Type = ref
   }}  
+
   }}{{FunctionArgument
  |example = set fWaterTraitValue to GetWaterTrait rWaterForm iTraitType
+
  |Name = traitID
 +
  |Type = int
 +
  |Value = 0-50
 +
  }}
 +
==Water Trait IDs==
 +
<pre>0&#09;Water property: Opacity
 +
1&#09;Flags bitmask (1 - Causes damage; 2 - Reflective)
 +
2&#09;Unknown
 +
3&#09;Unknown
 +
4&#09;Unknown
 +
5&#09;Unknown
 +
6&#09;Water property: Sun power
 +
7&#09;Water property: Reflectivity
 +
8&#09;Water property: Fresnel amount
 +
9&#09;Unknown
 +
10&#09;Fog property: Above water - Fog distance (near plane)
 +
11&#09;Fog property: Above water - Fog distance (far plane)
 +
12&#09;Shallow color (RRRGGGBBB)
 +
13&#09;Deep color (RRRGGGBBB)
 +
14&#09;Reflection color (RRRGGGBBB)
 +
15&#09;Unknown
 +
16&#09;Rain sim: Force
 +
17&#09;Rain sim: Velocity
 +
18&#09;Rain sim: Falloff
 +
19&#09;Rain sim: Dampener
 +
20&#09;Displacement sim: Starting size
 +
21&#09;Displacement sim: Force
 +
22&#09;Displacement sim: Velocity
 +
23&#09;Displacement sim: Falloff
 +
24&#09;Displacement sim: Dampener
 +
25&#09;Rain sim: Starting size
 +
26&#09;Noise property: Normals - Noise scale
 +
27&#09;Noise property: Layer 1 - Wind direction
 +
28&#09;Noise property: Layer 2 - Wind direction
 +
29&#09;Noise property: Layer 3 - Wind direction
 +
30&#09;Noise property: Layer 1 - Wind speed
 +
31&#09;Noise property: Layer 2 - Wind speed
 +
32&#09;Noise property: Layer 3 - Wind speed
 +
33&#09;Noise property: Normals - Depth falloff start
 +
34&#09;Noise property: Normals - Depth falloff end
 +
35&#09;Fog property: Above Water - Fog amount
 +
36&#09;Nosie property: Normals - UV scale
 +
37&#09;Fog property: Under Water - Fog amount
 +
38&#09;Fog property: Under Water - Fog distance (near Plane)
 +
39&#09;Fog property: Under Water - Fog distance (far Plane)
 +
40&#09;Water property: Distortion amount
 +
41&#09;Water property: Shininess
 +
42&#09;Water property: Reflection HDR multiplier
 +
43&#09;Water property: Light radius
 +
44&#09;Water property: Light brightness
 +
45&#09;Water property: Layer 1 - UV scale
 +
46&#09;Water property: Layer 2 - UV scale
 +
47&#09;Water property: Layer 3 - UV scale
 +
48&#09;Water property: Layer 1 - Amplitude scale
 +
49&#09;Water property: Layer 2 - Amplitude scale
 +
50&#09;Water property: Layer 3 - Amplitude scale</pre>
 +
  |example = set fShininess to GetWaterTrait NVCleanWater 41
 
}}
 
}}
{{Water Traits}}
 
 
==See Also==
 
==See Also==
 
*[[SetWaterTrait]]
 
*[[SetWaterTrait]]
 
+
[[Category:Functions (Lutana)]]
[[Category:Functions_(Lutana)]]
+
[[Category:Water Functions (Lutana)]]
[[Category:Water_Functions_(Lutana)]]
+

Latest revision as of 17:08, 24 March 2017

A function added by the JIP NVSE Plugin.

Description

Returns the value of a numeric trait (determined by traitID) of the specified Water Type form.

Syntax

(traitValue:float) GetWaterTrait waterType:ref traitID:int{0-50}

Water Trait IDs

0	Water property: Opacity
1	Flags bitmask (1 - Causes damage; 2 - Reflective)
2	Unknown
3	Unknown
4	Unknown
5	Unknown
6	Water property: Sun power
7	Water property: Reflectivity
8	Water property: Fresnel amount
9	Unknown
10	Fog property: Above water - Fog distance (near plane)
11	Fog property: Above water - Fog distance (far plane)
12	Shallow color (RRRGGGBBB)
13	Deep color (RRRGGGBBB)
14	Reflection color (RRRGGGBBB)
15	Unknown
16	Rain sim: Force
17	Rain sim: Velocity
18	Rain sim: Falloff
19	Rain sim: Dampener
20	Displacement sim: Starting size
21	Displacement sim: Force
22	Displacement sim: Velocity
23	Displacement sim: Falloff
24	Displacement sim: Dampener
25	Rain sim: Starting size
26	Noise property: Normals - Noise scale
27	Noise property: Layer 1 - Wind direction
28	Noise property: Layer 2 - Wind direction
29	Noise property: Layer 3 - Wind direction
30	Noise property: Layer 1 - Wind speed
31	Noise property: Layer 2 - Wind speed
32	Noise property: Layer 3 - Wind speed
33	Noise property: Normals - Depth falloff start
34	Noise property: Normals - Depth falloff end
35	Fog property: Above Water - Fog amount
36	Nosie property: Normals - UV scale
37	Fog property: Under Water - Fog amount
38	Fog property: Under Water - Fog distance (near Plane)
39	Fog property: Under Water - Fog distance (far Plane)
40	Water property: Distortion amount
41	Water property: Shininess
42	Water property: Reflection HDR multiplier
43	Water property: Light radius
44	Water property: Light brightness
45	Water property: Layer 1 - UV scale
46	Water property: Layer 2 - UV scale
47	Water property: Layer 3 - UV scale
48	Water property: Layer 1 - Amplitude scale
49	Water property: Layer 2 - Amplitude scale
50	Water property: Layer 3 - Amplitude scale

Example

set fShininess to GetWaterTrait NVCleanWater 41

See Also

Personal tools