Component:FileVisual: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=File Visual
|Name=File Visual
}}
}}
{{stub}}
The '''FileVisual''' component is used to handle the creation and interfacing with a file object, which is spawned into the world from inventory or using the "Raw" option when [[Importing]].


== Usage ==
== Files ==
{{Table ComponentFields
{{Table ComponentFields
|MetadataSource|{{RootFieldType|RelayRef`1|[[Component:FileMetadata|FileMetadata]]}}|TypeAdv0=true|
|MetadataSource|{{RootFieldType|RelayRef`1|[[Component:FileMetadata|FileMetadata]]}}|TypeAdv0=true| The component that handles importing and storing the file data this component is representing the visual of.
|TypeLabel|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv1=true|
|TypeLabel|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv1=true| The label that determines the file type/extension (aka the "png" part of "hello.png")
|NameLabel|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv2=true|
|NameLabel|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv2=true| The name of the file before the extension (aka the "hello" part of "hello.png")
|FillMaterial|'''[[PBS_DualSidedMetallic|PBS_DualSidedMetallic]]'''|TypeAdv3=true|
|FillMaterial|'''[[PBS_DualSidedMetallic|PBS_DualSidedMetallic]]'''|TypeAdv3=true| The material being used for the file icon in the center.
|OutlineMaterial|'''[[PBS_DualSidedMetallic|PBS_DualSidedMetallic]]'''|TypeAdv4=true|
|OutlineMaterial|'''[[PBS_DualSidedMetallic|PBS_DualSidedMetallic]]'''|TypeAdv4=true| The material being used to outline the file icon.
|TypeMaterial|'''[[PBS_DualSidedMetallic|PBS_DualSidedMetallic]]'''|TypeAdv5=true|
|TypeMaterial|'''[[PBS_DualSidedMetallic|PBS_DualSidedMetallic]]'''|TypeAdv5=true| The material being used to color the file type. this can be orange for models, and the color varies based on file type.
}}
}}


== Behavior ==
== Usage ==
Is used by the game to generate and handle the visuals of raw files. Is usually not directly utilized by the player.


== Examples ==
== Examples ==
{{stub}}
We need a picture of an imported raw file (what about the whats this.owo picture meme)


== See Also ==
== See Also ==
Line 23: Line 26:
[[Category:Components:Utility{{#translation:}}|File Visual]]
[[Category:Components:Utility{{#translation:}}|File Visual]]
[[Category:Components{{#translation:}}|File Visual]]
[[Category:Components{{#translation:}}|File Visual]]
[[Category:ComponentStubs]]

Latest revision as of 17:14, 22 December 2024

Component image 
File Visual component as seen in the Scene Inspector

The FileVisual component is used to handle the creation and interfacing with a file object, which is spawned into the world from inventory or using the "Raw" option when Importing.

Files

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
MetadataSource direct RelayRef`1<FileMetadata> The component that handles importing and storing the file data this component is representing the visual of.
TypeLabel TextRenderer The label that determines the file type/extension (aka the "png" part of "hello.png")
NameLabel TextRenderer The name of the file before the extension (aka the "hello" part of "hello.png")
FillMaterial PBS_DualSidedMetallic The material being used for the file icon in the center.
OutlineMaterial PBS_DualSidedMetallic The material being used to outline the file icon.
TypeMaterial PBS_DualSidedMetallic The material being used to color the file type. this can be orange for models, and the color varies based on file type.

Usage

Is used by the game to generate and handle the visuals of raw files. Is usually not directly utilized by the player.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


We need a picture of an imported raw file (what about the whats this.owo picture meme)

See Also