Automated: create new component page |
m grammar |
||
| (2 intermediate revisions by 2 users not shown) | |||
| 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 platform. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|PlatformName|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv0=true| | |PlatformName|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv0=true| The name of the platform. | ||
|ShortNamePrefix|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv1=true| | |ShortNamePrefix|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv1=true| The short name of the platform, used in record strings. | ||
|Abbreviation|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| | |Abbreviation|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| The abreviation of the platform, useful for referring to it in casual conversation. | ||
|Domain|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| | |Domain|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| The website of the plaform. | ||
|Email|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv4=true| | |Email|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv4=true| The platform's email address. | ||
|DiscordInviteUrl|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv5=true| | |DiscordInviteUrl|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv5=true| The URL to get to the platform's Discord. | ||
|PoliciesPage|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv6=true| | |PoliciesPage|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv6=true| The TOS of the platform. | ||
|PatreonUrl|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv7=true| | |PatreonUrl|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv7=true| The Patreon URL of the platform. | ||
|GitHubProfile|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv8=true| | |GitHubProfile|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv8=true| The Github profile of the platform. | ||
|GitHubIssuesRepository|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv9=true| | |GitHubIssuesRepository|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv9=true| The Github issues page of the platform. | ||
|AuthScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv10=true| | |AuthScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv10=true| The authorization scheme of the platform. | ||
|AppScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv11=true| | |AppScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv11=true| The app scheme of the platform. | ||
|DBScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv12=true| | |DBScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv12=true| The data base scheme of the platform. used in asset urls. | ||
|SessionScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv13=true| | |SessionScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv13=true| The session scheme of the platform. used in session links. | ||
|RecordScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv14=true| | |RecordScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv14=true| The record scheme of the platform. used in item link urls. | ||
|UserSessionScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv15=true| | |UserSessionScheme|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv15=true| 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 == | == Examples == | ||
| Line 33: | Line 34: | ||
[[Category:Components:Utility{{#translation:}}|Platform Info]] | [[Category:Components:Utility{{#translation:}}|Platform Info]] | ||
[[Category:Components{{#translation:}}|Platform Info]] | [[Category:Components{{#translation:}}|Platform Info]] | ||
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
| 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.