Component:PlatformInfo

From Resonite Wiki
Revision as of 18:10, 24 December 2024 by 989onan (talk | contribs) (add info)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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 Abreviations and ways to refer to the plaform.

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.
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

Used in the resonite links book item so that the links in the book don't ever go out of date.

See Also