Component:PlatformInfo: Difference between revisions

From Resonite Wiki
m This isn't used in the linking book at all? Neither in the cloud home nor in Resonite Essentials. Also some spellcheck
m grammar
 
Line 3: Line 3:
|Name=Platform Info
|Name=Platform Info
}}
}}
The '''PlatformInfo''' component is used where data about the platform that [[FrooxEngine]] is running under (In this case, [[Resonite]]) for the purpose of providing info to users like social links and language like Abbreviations and ways to refer to the planform.   
The '''PlatformInfo''' component is used where data about the platform that [[FrooxEngine]] is running under (In this case, [[Resonite]]) for the purpose of providing info to users like social links and language like Abbreviations and ways to refer to the platform.   


== Usage ==
== Usage ==

Latest revision as of 07:34, 10 March 2025

Component image 
Platform Info component as seen in the Scene Inspector

The PlatformInfo component is used where data about the platform that FrooxEngine is running under (In this case, Resonite) for the purpose of providing info to users like social links and language like Abbreviations and ways to refer to the platform.

Usage

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.
PlatformName raw output of String The name of the platform.
ShortNamePrefix raw output of String The short name of the platform, used in record strings.
Abbreviation raw output of String The abreviation of the platform, useful for referring to it in casual conversation.
Domain raw output of String The website of the plaform.
Email raw output of String The platform's email address.
DiscordInviteUrl raw output of String The URL to get to the platform's Discord.
PoliciesPage raw output of String The TOS of the platform.
PatreonUrl raw output of String The Patreon URL of the platform.
GitHubProfile raw output of String The Github profile of the platform.
GitHubIssuesRepository raw output of String The Github issues page of the platform.
AuthScheme raw output of String The authorization scheme of the platform.
AppScheme raw output of String The app scheme of the platform.
DBScheme raw output of String The data base scheme of the platform. used in asset urls.
SessionScheme raw output of String The session scheme of the platform. used in session links.
RecordScheme raw output of String The record scheme of the platform. used in item link urls.
UserSessionScheme raw output of String The user session scheme of the platform.

Usage

Can be used to get up to date information on the platform (Resonite) in real time for in use in items or worlds.

Examples

See Also