Jump to content
Main menu
Main menu
move to sidebar
hide
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
SimTX Wiki
Search
Search
Appearance
Create account
Log in
Personal tools
Create account
Log in
Pages for logged out editors
learn more
Contributions
Talk
Editing
SimTX API/Packets/ServerHello
(section)
Page
Discussion
English
Read
Edit
Edit source
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
Edit source
View history
General
What links here
Related changes
Special pages
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Fields == {| class="wikitable" ! # !! Field !! Type !! Description |- | 1 || <code>status</code> || [[SimTX API/Data types#HelloStatus|HelloStatus]] || Result of the hello. Anything other than <code>HELLO_STATUS_ACCEPTED</code> is followed by the server closing the connection. |- | 2 || <code>message</code> || <code>string</code> || Human-readable explanation. Empty on success. Show it to the user on rejection. |- | 3 || <code>account</code> || [[#Account|Account]] || The account, for authenticated connections. Unset for anonymous ones. |- | 4 || <code>features</code> || <code>repeated string</code> || Optional server capabilities of this deployment, from the [[SimTX API/Compatibility and versioning#Feature registry|feature registry]]. Ignore names you do not know. |- | 5 || <code>server_version</code> || <code>string</code> || Server software version, for display and diagnostics. |- | 6 || <code>server_time_ms</code> || <code>int64</code> || Server wall clock, Unix ms. |- | 7 || <code>simulation_time_ms</code> || <code>int64</code> || Simulated world clock, Unix ms. Use it, not the local clock, as "now" for satellite positions and pass predictions. |- | 8 || <code>protocol_revision</code> || <code>int32</code> || Highest protocol revision the server implements. |} === Account === <syntaxhighlight lang="protobuf"> message Account { bytes account_id = 1; string handle = 2; string display_name = 3; repeated string permissions = 4; int64 authorization_revision = 5; int64 lease_expires_at_ms = 6; } </syntaxhighlight> {| class="wikitable" ! # !! Field !! Type !! Description |- | 1 || <code>account_id</code> || <code>bytes</code> || 16-byte account UUID. |- | 2 || <code>handle</code> || <code>string</code> || Account handle. |- | 3 || <code>display_name</code> || <code>string</code> || Display name. |- | 4 || <code>permissions</code> || <code>repeated string</code> || Effective [[SimTX API/Permissions|permissions and numeric capabilities]] on this server, after the credential's scope, for example <code>game.transmit</code> or <code>tx.pa_limit.400</code>. |- | 5 || <code>authorization_revision</code> || <code>int64</code> || Revision of the account's authorisation data. Changes when permissions change. |- | 6 || <code>lease_expires_at_ms</code> || <code>int64</code> || When the server will close this authenticated connection, Unix ms. About 12 hours after the hello. |}
Summary:
Please note that all contributions to SimTX Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
SimTX Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)