ItemLiquidLevel
- Last UpdatedDec 16, 2023
- 3 minute read
The ItemLiquidLevel node transforms the representation of a liquid container from a static steel vessel to a transparent, virtual reality container that shows the level of the contained fluid.
-
The ItemLiquidLevel node inherits from Item.
Platform support
This node is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-Portable WASM platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
Full support |
|
|
|
|
|
|
Code example
This is a code example for ItemLiquidLevel.
<ItemLiquidLevel name="D1300" displayName="@lang:liquidLevelDisplayName@" displayValue="[*'{0:P}',n:@D1300.value@]" labelTextureFont="Arial,Bold,21" labelTextureColor="0.17 0.22 0.71" labelPosition="28.92365 3.171597 -28.40492" itemPosition="28.46006 3.985847 -26.40752" tags="Animation,Liquid Level,Section01" levelYMin="2.114235" levelYMax="5.902625" levelY="2.114235" action.show.text="@lang:actionShow@" action.hide.text="@lang:actionHide@" levelXMin="19.15705" levelXMax="37.29548" levelZMin="-28.08117" levelZMax="-24.31876" levelX="19.15705 37.29548" levelZ="-28.00797 -24.39198"/>
Default actions
The default actions for ItemLiquidLevel.
|
Action |
Hotkey |
Text |
Description |
|---|---|---|---|
|
Hide |
LT |
Hide |
Makes the container opaque. |
|
Show |
RT |
Show |
Makes the container transparent. |
ItemLiquidLevel fields
These are the fields for ItemLiquidLevel node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > NodeBaseMovable > Item > ItemLiquidLevel
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
containerMesh |
sstring |
Optional |
Auto-populated |
Automatic name of the container mesh. Can be overridden if the item does not support naming convention. |
|
fadeTime |
sfloat |
Optional |
1 |
Hides/shows transition time in seconds. |
|
fadeDestAlpha |
sfloat |
Optional |
0.5 |
The container fade level at the end of the showing transition. |
|
isInside |
sbool |
Read only |
false |
Becomes true when the avatar camera is inside the liquid mesh. Becomes false when inside container and not in liquid. |
|
levelX |
svec2 |
Read only |
Internally calculated |
Current liquid x maximum and minimum values. |
|
levelXMin |
sfloat |
Read only |
Internally calculated |
Absolute minimum possible x value. |
|
levelXMax |
sfloat |
Read only |
Internally calculated |
Absolute maximum possible x value. |
|
levelY |
svec2 |
Read only |
Internally calculated |
Current liquid y maximum and minimum values. |
|
levelYMin |
sfloat |
Read only |
Internally calculated |
Absolute minimum possible y value. |
|
levelYMax |
sfloat |
Read only |
Internally calculated |
Absolute maximum possible y value. |
|
levelZ |
svec2 |
Read only |
Internally calculated |
Current liquid z maximum and minimum values. |
|
levelZMin |
sfloat |
Read only |
Internally calculated |
Absolute minimum possible z value. |
|
levelZMax |
sfloat |
read only |
Internally calculated |
Absolute maximum possible z value. |
|
liquidMesh |
sstring |
Optional |
Auto-populated |
Automatic name of the liquid mesh. Can be overridden if the item does not support naming convention. |
|
mode |
senum |
Optional |
Linear |
Defines interpolation mode. Options are: Collapse, Linear, Linearnew, Plane, Circular, Bilinear_x, and Bilinar_z. |
|
planeNormal |
svec3 |
Optional |
0 1 0 |
Enables tilt for the surface plane by setting its normal vector. |
|
redrawRefresh |
sfloat |
Optional |
0.1 |
Refresh interval. |
|
value |
sfloat |
Optional |
0 |
Defines the height of the liquid in the range 0-1. |
|
value_b |
sfloat |
Optional |
0 |
Defines the second height of the liquid in the range 0-1. Used only when mode is Bilinear_x or Bilinear_z. |
|
valueBase |
sfloat |
Optional |
0 |
Defines the liquid base height when it must differ from the bottom. It works only in linear and circular modes. |
|
visible |
sbool |
Read only |
false |
Becomes true when the fluid is shown. Becomes false when fluid is hidden. |