server.isHosting: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created stub for server.isHosting function)
 
m (s/variable/function/)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=server.isHosting
|name=server.isHosting
|version=1.12
|version=1.12
|description=
|description=The function ''server.isHosting'' returns the hosting status of the local machine.
 
<br/>
All MapTool instances ''must'' have a server running of some type.  There are two choices: either a ''personal'' server (meaning that it is not listening for incoming connections), and a true ''server'' (meaning that incoming connections will be accepted, assuming that there are no other constraints like firewall settings).
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Line 10: Line 10:
</syntaxhighlight>
</syntaxhighlight>


Returns {{code|true}} if the local machine is hosting a MapTool server and {{code|false}} otherwise.
|also=
{{func|server.isPersonal}}, {{func|server.isServer}}
}}
}}
[[Category:Server Function]]
[[Category:Server Function]][[Category:Macro Function]]

Latest revision as of 22:14, 1 December 2023

server.isHosting() Function

Introduced in version 1.12
The function server.isHosting returns the hosting status of the local machine.


All MapTool instances must have a server running of some type. There are two choices: either a personal server (meaning that it is not listening for incoming connections), and a true server (meaning that incoming connections will be accepted, assuming that there are no other constraints like firewall settings).

Usage

server.isHosting()

Returns true if the local machine is hosting a MapTool server and false otherwise.


See Also