Component:DocumentInterface: Difference between revisions

From Resonite Wiki
VisualWikitext
add documentinterface component
 
add info
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Infobox Component
|Image=DocumentInterface.png
|Name=Document Interface
}}
The '''DocumentInterface''' component is a [[Favorites]] Type Component that is used in the default or custom document viewers.
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ItemName|IField`1|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of this interface.
|SpawningUser|UserRef|
|SpawningUser|UserRef| The user that spawned this document viewer.
|SpawningUserID|IField`1|
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| The field that contains the user ID of the user that spawned this document viewer.
|IsInstance|Bool|
|IsInstance|Bool| Whether this was spawned by the [[Favorites]] system (true) or spawned from inventory (false)
|URL|IField`1|
|URL|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv4=true| The URL field of the document asset component this document viewer is showing.
|Page|IField`1|
|Page|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv5=true| The field that controls which page this document viewer is currently showing.
}}
}}


== Usage ==
{{stub}}
== Examples ==
{{stub}}
== See Also ==
{{Template:EntityInterface SeeAlso}}


[[Category:Components:Utility:Entity_Interfaces]]
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Document Interface]]
[[Category:Components{{#translation:}}|Document Interface]]

Latest revision as of 00:33, 13 January 2025

Component image 
Document Interface component as seen in the Scene Inspector

The DocumentInterface component is a Favorites Type Component that is used in the default or custom document viewers.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
ItemName IField`1<String> The name of this interface.
SpawningUser UserRef The user that spawned this document viewer.
SpawningUserID IField`1<String> The field that contains the user ID of the user that spawned this document viewer.
IsInstance Bool Whether this was spawned by the Favorites system (true) or spawned from inventory (false)
URL IField`1<Uri> The URL field of the document asset component this document viewer is showing.
Page IField`1<Int> The field that controls which page this document viewer is currently showing.

Usage

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

Examples

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

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:DocumentInterface&oldid=94341"