Socket-template-list Container

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(network)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
 
{{ORP-top}}
 
{{ORP-top}}
A container type tag for defining socket templates for use within [[TNI_Socket_Interface|TNISocket]] within [[TNI|Trainz Native Interface]].
+
A container type tag for defining socket templates for use within [[TNI_Socket_Interface|TNISocket]] within [[TrainzNativeInterface|Trainz Native Interface]].
  
 
==Supported Tags==
 
==Supported Tags==
Line 11: Line 11:
  
 
====network====
 
====network====
:Type: list
+
:Type: string
:Desc: If true this is an 'ambient' sound, ambient sounds are played in 2D and do not make use of 3D positioning in the world other than to affect volume. Unlike positional sounds, ambient sounds may be stereo.
+
:Desc: Specifies "local", "lan" or "wan" connection
 +
 
 
====domain====
 
====domain====
:Type:  
+
:Type: string
:Desc:  
+
:Desc: Restricts connections to a specific domain
 
====ip====
 
====ip====
:Type:  
+
:Type: string
:Desc:  
+
:Desc: Restricts connections to a specific IP address
 
====port====
 
====port====
:Type:  
+
:Type: integer
:Desc:  
+
:Desc: Restricts connections to a specific port number (compulsory)
  
 
==Example config.txt==
 
==Example config.txt==
Line 30: Line 31:
 
   trainz-build                            4.6
 
   trainz-build                            4.6
 
   tni-library-name                        "TNISocketTest"
 
   tni-library-name                        "TNISocketTest"
 
+
 
 
   tni-socket-templates
 
   tni-socket-templates
 
   {
 
   {

Latest revision as of 10:02, 12 December 2017

A container type tag for defining socket templates for use within TNISocket within Trainz Native Interface.

Contents

[edit] Supported Tags

Each subcontainer supports the following tags. Each tag is shown here with its default value.

 network                                 ""
 domain                                  ""
 ip                                      ""
 port                                    0

[edit] network

Type: string
Desc: Specifies "local", "lan" or "wan" connection

[edit] domain

Type: string
Desc: Restricts connections to a specific domain

[edit] ip

Type: string
Desc: Restricts connections to a specific IP address

[edit] port

Type: integer
Desc: Restricts connections to a specific port number (compulsory)

[edit] Example config.txt

Sample config.txt file for a TNI library asset which connects to another process on the local machine:

 kind                                    "library"
 kuid                                    <KUID:0:0>
 trainz-build                            4.6
 tni-library-name                        "TNISocketTest"
 
 tni-socket-templates
 {
   0
   {
     network                             "local"
     port                                7357
   }
 }


[edit] Categories

Personal tools