Module:Test2/doc: Difference between revisions

From Resonite Wiki
add example usage
 
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<h2>The [[Component:Text|Text]] Component</h2>
{{#Invoke:Test2|GenerateUI
{{#Invoke:Test2|GenerateUI
|Name=Text
|Name=Text
|Fields=
|Fields=
[
[
{"Name":"persistent", "FieldType":"Sync", "Type":"Bool"},
{"Name":"persistent", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"UpdateOrder", "FieldType":"Sync", "Type":"Int"},
{"Name":"UpdateOrder", "FieldType":"Sync", "Type":"int", "Value": 0},
{"Name":"Enabled", "FieldType":"Sync", "Type":"Bool"},
{"Name":"Enabled", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"Font", "FieldType":"AssetRef", "Type":"FrooxEngine.FontSet"},
{"Name":"Font", "FieldType":"AssetRef", "Type":"FrooxEngine.FontSet", "Value": "FontChain on Root (ID16F00)"},
{"Name":"Content", "FieldType":"Sync", "Type":"String"},
{"Name":"Content", "FieldType":"Sync", "Type":"String", "Value": null},
{"Name":"ParseRichText", "FieldType":"Sync", "Type":"Bool"},
{"Name":"ParseRichText", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"NullContent", "FieldType":"Sync", "Type":"String"},
{"Name":"NullContent", "FieldType":"Sync", "Type":"String", "Value": null},
{"Name":"Size", "FieldType":"Sync", "Type":"Float", "Range":[0.1, 128.0]},
{"Name":"Size", "FieldType":"Sync", "Type":"float", "Range":[0.1, 128.0], "Value": 64.0},
{"Name":"HorizontalAlign", "FieldType":"Sync", "Type":"TextHorizontalAlignment"},
{"Name":"HorizontalAlign", "FieldType":"Sync", "Type":"TextHorizontalAlignment", "Value": "Left", "Enum": true},
{"Name":"VerticalAlign", "FieldType":"Sync", "Type":"TextVerticalAlignment"},
{"Name":"VerticalAlign", "FieldType":"Sync", "Type":"TextVerticalAlignment", "Value": "Top", "Enum": true},
{"Name":"AlignmentMode", "FieldType":"Sync", "Type":"Elements.Assets.AlignmentMode"},
{"Name":"AlignmentMode", "FieldType":"Sync", "Type":"Elements.Assets.AlignmentMode", "Value": "Geometric", "Enum": true},
{"Name":"Color", "FieldType":"Sync", "Type":"ColorX"},
{"Name":"Color", "FieldType":"Sync", "Type":"colorX", "Value": [0,0,0,1,"sRGB"]},
{"Name":"Materials", "FieldType":"SyncAssetList", "Type":"Material"},
{"Name":"Materials", "FieldType":"SyncAssetList", "Type":"Material", "Value": ["UI_TextUnlitMaterial on  Root (ID1A600)"]},
{"Name":"LineHeight", "FieldType":"Sync", "Type":"Float", "Range":[0.25, 2.0]},
{"Name":"LineHeight", "FieldType":"Sync", "Type":"float", "Range":[0.25, 2.0], "Value": 0.8},
{"Name":"MaskPattern", "FieldType":"Sync", "Type":"String"},
{"Name":"MaskPattern", "FieldType":"Sync", "Type":"String", "Value": null},
{"Name":"HorizontalAutoSize", "FieldType":"Sync", "Type":"Bool"},
{"Name":"HorizontalAutoSize", "FieldType":"Sync", "Type":"bool", "Value": false},
{"Name":"VerticalAutoSize", "FieldType":"Sync", "Type":"Bool"},
{"Name":"VerticalAutoSize", "FieldType":"Sync", "Type":"bool", "Value": false},
{"Name":"AutoSizeMin", "FieldType":"Sync", "Type":"Float"},
{"Name":"AutoSizeMin", "FieldType":"Sync", "Type":"float", "Value": 8.0},
{"Name":"AutoSizeMax", "FieldType":"Sync", "Type":"Float"},
{"Name":"AutoSizeMax", "FieldType":"Sync", "Type":"float", "Value": 64.0},
{"Name":"CaretPosition", "FieldType":"Sync", "Type":"Int"},
{"Name":"CaretPosition", "FieldType":"Sync", "Type":"int", "Value": -1},
{"Name":"SelectionStart", "FieldType":"Sync", "Type":"Int"},
{"Name":"SelectionStart", "FieldType":"Sync", "Type":"int", "Value": -1},
{"Name":"CaretColor", "FieldType":"Sync", "Type":"ColorX"},
{"Name":"CaretColor", "FieldType":"Sync", "Type":"colorX", "Value": [0,0,0,0,"Linear"]},
{"Name":"SelectionColor", "FieldType":"Sync", "Type":"ColorX"},
{"Name":"SelectionColor", "FieldType":"Sync", "Type":"colorX", "Value": [0,0,0,0,"Linear"]},
{"Name":"InteractionTarget", "FieldType":"Sync", "Type":"Bool"},
{"Name":"interactionTarget", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"_legacyFontMaterial", "FieldType":"SyncRef", "Type":"FontMaterial"},
{"Name":"_legacyFontMaterial", "FieldType":"SyncRef", "Type":"FontMaterial", "Value": null},
{"Name":"_legacyAlign", "FieldType":"Sync", "Type":"Alignment"}
{"Name":"_legacyAlign", "FieldType":"Sync", "Type":"Alignment", "Value": "TopLeft", "Enum": true}
]
|}}
 
<h2>The [[Component:RelativePositioner|RelativePositioner]] Component</h2>
 
{{#Invoke:Test2|GenerateUI
|Name=RelativePositioner
|Fields=[
{"Name":"persistent", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"UpdateOrder", "FieldType":"Sync", "Type":"int", "Value": 0},
{"Name":"Enabled", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"Reference", "FieldType":"SyncRef", "Type":"Slot", "Value": null},
{"Name":"ReferenceBoundsSpace", "FieldType": "SyncObject", "Type": "RootSpace", "Fields": [
  {"Name": "LocalSpace", "FieldType":"SyncRef", "Type":"Slot", "Value": null},
  {"Name": "UseParentSpace", "FieldType":"Sync", "Type":"bool", "Value": false},
  {"Name": "Default", "FieldType":"Sync", "Type":"DefaultSpace", "Value": "WorldRoot", "Enum": true},
  {"Name": "OverrideRootSpace", "FieldType":"SyncRef", "Type":"RootSpace", "Value": null}, <!-- it's actually a RelayRef, but it looks the same -->
  {"Name": "Use Global Space", "FieldType": "DelegateButton"},
  {"Name": "Use Local Space", "FieldType": "DelegateButton"},
  {"Name": "Use Parent Space", "FieldType": "DelegateButton"}
]},
{"Name":"ReferenceAnchor", "FieldType":"Sync", "Type":"float3", "Value": [0,0,0]},
{"Name":"ReferenceOffset", "FieldType":"Sync", "Type":"float3", "Value": [0,0,0]},
{"Name":"DestroyAfterDone", "FieldType":"Sync", "Type":"bool", "Value": false},
{"Name": "_target", "FieldType":"SyncRef", "Type":"float3", "Value": null} <!-- it's actually a FieldDrive, but it looks the same -->
]
|}}
 
<h2>The [[Component:AssetMultiplexer|AssetMultiplexer<ITexture2D>]] Component</h2>
 
{{#Invoke:Test2|GenerateUI
|Name=AssetMultiplexer<ITexture2D>
|Fields=[
{"Name":"persistent", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"UpdateOrder", "FieldType":"Sync", "Type":"int", "Value": 0},
{"Name":"Enabled", "FieldType":"Sync", "Type":"bool", "Value": true},
{"Name":"Target", "FieldType":"SyncRef", "Type":"AssetRef<ITexture2D>", "Value": null}, <!-- it's actually a DriveRef, but it looks the same -->
{"Name":"Index", "FieldType":"Sync", "Type":"int", "Value": 0},
{"Name":"Assets", "FieldType":"SyncAssetList", "Type":"ITexture2D", "Value": [0, 0, 0]}
]
]
|}}
|}}

Latest revision as of 10:58, 12 February 2024

The Text Component

Text
Duplicate
Destroy
persistent:
UpdateOrder:
0
Enabled:
Font:
FontChain on Root (ID16F00)
Content:
null
ParseRichText:
NullContent:
null
Size:
64
HorizontalAlign:
<<
Left
>>
VerticalAlign:
<<
Top
>>
AlignmentMode:
<<
Geometric
>>
Color:
R
0
G
0
B
0
A
1
Profile:
<<
sRGB
>>
Materials (list):
0:
UI_TextUnlitMaterial on Root (ID1A600)
X
Add
LineHeight:
0.8
MaskPattern:
null
HorizontalAutoSize:
VerticalAutoSize:
AutoSizeMin:
8
AutoSizeMax:
64
CaretPosition:
-1
SelectionStart:
-1
CaretColor:
R
0
G
0
B
0
A
0
Profile:
<<
Linear
>>
SelectionColor:
R
0
G
0
B
0
A
0
Profile:
<<
Linear
>>
interactionTarget:
_legacyFontMaterial:
null
_legacyAlign:
<<
TopLeft
>>

The RelativePositioner Component

RelativePositioner
Duplicate
Destroy
persistent:
UpdateOrder:
0
Enabled:
Reference:
null
ReferenceBoundsSpace:
LocalSpace:
null
UseParentSpace:
Default:
<<
WorldRoot
>>
OverrideRootSpace:
null
Use Global Space
Use Local Space
Use Parent Space
ReferenceAnchor:
x
0
y
0
z
0
ReferenceOffset:
x
0
y
0
z
0
DestroyAfterDone:
_target:
null

The AssetMultiplexer<ITexture2D> Component

AssetMultiplexer<ITexture2D>
Duplicate
Destroy
persistent:
UpdateOrder:
0
Enabled:
Target:
null
Index:
0
Assets (list):
0:
null
---
Clear
📋
X
1:
null
---
Clear
📋
X
2:
null
---
Clear
📋
X
Add