Tutorials:Action Variables: Difference between revisions
DoctorDalek (talk | contribs) No edit summary |
DoctorDalek (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
[[Category:Tutorials]] | [[Category:Tutorials]] | ||
The LANCommander Playnite addon allows the use of some special variables in primary actions. These variables are expanded upon launch of the game. Any environment variables (%TEMP%, %AppData%, etc.) and special folders are also expanded at this time. | The LANCommander Playnite addon allows the use of some special variables in primary actions. These variables are expanded upon launch of the game. Any [https://ss64.com/nt/syntax-variables.html environment variables] (%TEMP%, %AppData%, etc.) and [https://learn.microsoft.com/en-us/dotnet/api/system.environment.specialfolder?view=net-8.0 special folders] (%MyDocuments%, %CommonPrograms%) are also expanded at this time. | ||
== Variables == | == Variables == | ||
| Line 22: | Line 22: | ||
| <code>{IPXRelayPort}</code> | | <code>{IPXRelayPort}</code> | ||
| The port of the IPX relay as specified in Settings | | The port of the IPX relay as specified in Settings | ||
|} | |||
== Server Action Variables == | |||
Additional variables are available through Server Actions (configurable when editing a server under the "Actions" tab). When specified, these actions are presented to the user as alternative primary actions. These are especially useful for providing direct connection details for a game server. | |||
{| class="wikitable" | |||
|- | |||
! Name | |||
! Description | |||
|- | |||
| <code>{ServerHost}</code> | |||
| The hostname of the server. Defaults to the host part of the LANCommander server address. Can be overridden using the "Host" field in a server. | |||
|- | |||
| <code>{ServerPort}</code> | |||
| The port of the server. Specified using the "Port" field in a server. | |||
|- | |||
| <code>{ServerIP}</code> | |||
| The resolved IP of the <code>{ServerHost}</code> variable | |||
|} | |} | ||
Latest revision as of 00:22, 22 February 2024
The LANCommander Playnite addon allows the use of some special variables in primary actions. These variables are expanded upon launch of the game. Any environment variables (%TEMP%, %AppData%, etc.) and special folders (%MyDocuments%, %CommonPrograms%) are also expanded at this time.
Variables
| Name | Description |
|---|---|
{DisplayWidth}
|
The width of the primary display in pixels |
{DisplayHeight}
|
The height of the primary display in pixels |
{ServerAddress}
|
The address of the currently authenticated LANCommander server |
{IPXRelayHost}
|
The host of the IPX relay as specified in Settings. If a hostname is provided, an attempt to resolve to an IP address will be made. |
{IPXRelayPort}
|
The port of the IPX relay as specified in Settings |
Server Action Variables
Additional variables are available through Server Actions (configurable when editing a server under the "Actions" tab). When specified, these actions are presented to the user as alternative primary actions. These are especially useful for providing direct connection details for a game server.
| Name | Description |
|---|---|
{ServerHost}
|
The hostname of the server. Defaults to the host part of the LANCommander server address. Can be overridden using the "Host" field in a server. |
{ServerPort}
|
The port of the server. Specified using the "Port" field in a server. |
{ServerIP}
|
The resolved IP of the {ServerHost} variable
|