Difference between revisions of "Region Debug Console"

From Second Life Wiki
Jump to navigation Jump to search
m (added keystroke for uk keymappings)
(Page layout redone, commands now match those on regions .. document makes sense)
Line 1: Line 1:
[[Category:Capabilities]]
[[Category:Capabilities]]
==Capability Documentation==
=The Command Console=
Post to Capability: "SimConsole"
The command console allows for a handful of region settings to be changed via text commands or http post operations from script.
 
Post:
    <llsd><string>help</string></llsd>
 
Response:
    <llsd><string>Response</string></llsd>


You must be an estate manager to change the settings.
==Commands==
==Commands==


* Help (Command)
* Help (Command)
<pre>
     Help is available for the following commands and topics. Type "help <topic>" for more information.
     Help is available for the following commands and topics. Type "help <topic>" for more information.
     Note that all commands are case insensitive.
     Note that all commands are case insensitive.
Line 17: Line 13:
       Get                Retrieve the value of a variable.
       Get                Retrieve the value of a variable.
       Set                Set the value of a variable.
       Set                Set the value of a variable.
       Variables          List variables you are authorized to view or modify.
       Unset              Returns a parameter to its built-in default. (Only available for certain parameters.)
       Restart            Restart the region after a specified amount of time (default 5mins).
      Parameters          List parameters you are authorized to view or modify.
 
       Restart            Restart the region after a specified amount of time (default 5mins)
</pre>
* Get (Command)
* Get (Command)
<pre>
     Syntax: get <parameter>
     Syntax: get <parameter>


       Retrieve the current value of a simulator or region variable. Note that if the variable was set since the region was restarted, the new value will be returned rather than the value used when the region started. This can be significant for some variables. For more information, see "help <variable>". To retrieve the value of a variable used at startup, use "get -s <variable>".
       Retrieve the current value of a simulator or region variable. Note that if the variable was set since the region was restarted, the new value will be returned rather than the value used when the region started. This can be significant for some variables. For more information, see "help <variable>". To retrieve the value of a variable used at startup, use "get -s <variable>".
 
</pre>
* Set (Command)
* Set (Command)
<pre>
     Syntax: set <variable> <value>
     Syntax: set <variable> <value>


Line 35: Line 34:
       Bool:    [ON/OFF] or [TRUE/FALSE] or [ENABLED/DISABLED]
       Bool:    [ON/OFF] or [TRUE/FALSE] or [ENABLED/DISABLED]
       Vector:  <1.34, -4.2, 8> in <x, y, z> order.
       Vector:  <1.34, -4.2, 8> in <x, y, z> order.
</pre>
* Unset (command)
<pre>
Syntax: unset <parameter>
Sets a parameter to its built-in default. Not all parameters have defaults
</pre>
* Help Parameters (Command)
<pre>
    Syntax: help parameters


* Help Variables (Command)
    You are authorized to access the following parameters in this region:
    Syntax: help variables
      You are authorized to access the following parameters in this region:


      accurate_terrain
    allow_return_encroaching_estate_object
        Enable more accurate terrain simulation at the cost of performance. Defaults to disabled.
    Allow land owners to return an Estate Manager's object that overlaps their land.
        Read/Write
    Read/Write


      allow_return_encroaching_estate_object
    allow_return_encroaching_object
        Allow land owners to return an Estate Manager's object that overlaps their land.
    Allow land owners to return a regular object that overlaps their land.
        Read/Write
    Read/Write


      allow_return_encroaching_object
    dynamic_pathfinding
        Allow land owners to return a regular object that overlaps their land.
    Enable/Disable pathfinding behaviors and navmesh updates. Requires a restart.
        Read/Write
    Read/Write


    lures_obey_telehubs
    If true, teleport lures obey telehubs if they exist.
    Read/Write


    optimize_terrain
    Allows estate managers to disable certain terrain optimizations and is provided only for backward compatibility. Defaults to true (optimization enabled). Requires a terrain edit or sim restart to take effect.
    Read/Write
</pre>
Note : The above commands are subject to change, so use 'help parameters' to determine the active ccommands for the current region.
* Restart (Command)
* Restart (Command)
<pre>
     Syntax: restart <minutes>
     Syntax: restart <minutes>
       Restart the region after a specified amount of time (default 5mins).
       Restart the region after a specified amount of time (default 5mins).
</pre>
Notes:
Can only accept positive integers.
If used during a active countdown will set the countdown to the specified time. Appears to have no throttling or wait timers. Giving the time "0" will cause the sim to shutdown immediately with no warning except for Second Life closing with a (Region is going down)


      Notes:
Restarts are warned to all clients with a message like this ([AlertMessage] /RESTART_X_MINUTES 5)
      Can only accept positive integers.
      If used during a active countdown will set the countdown to the specified time.
      Appears to have no throttling or wait timers.
      Giving the time "0" will cause the sim to shutdown immediately with no warning except for Second Life closing with a (Region is going down)
      Restarts are warned to all clients with a message like this ([AlertMessage] /RESTART_X_MINUTES 5) (The dialog thing that normally appears.)


==Notable Responses==
==Notable Responses==
Line 70: Line 85:
* You are not authorized to perform that command. This event has been logged.
* You are not authorized to perform that command. This event has been logged.


==LSL possibilities==
==To open the console==
<pre>CTRL + SHIFT + `  (CTRL + SHIFT + backtick) {{ENTER}}
( on a Keyboard with a UK Keymap use: CTRL + SHIFT + @ )
</pre>
 
=LSL possibilities=
If you have a bot with estate manager rights hand a LSL script the SimConsole Capability URL you can send commands to it. Note, you can't read the responses.
If you have a bot with estate manager rights hand a LSL script the SimConsole Capability URL you can send commands to it. Note, you can't read the responses.
<pre>
    llHTTPRequest("https://<YOUR REGION HOST>.agni.lindenlab.com:12043/cap/<YOUR CAP HERE>",[HTTP_METHOD,"POST"],"<llsd><string>set accurate_terrain FALSE</string></llsd>");
</pre>
===Capability Documentation===
Post to Capability: "SimConsole"


     llHTTPRequest("https://<YOUR REGION HOST>.agni.lindenlab.com:12043/cap/<YOUR CAP HERE>",[HTTP_METHOD,"POST"],"<llsd><string>set accurate_terrain FALSE</string></llsd>");
Post:
     <llsd><string>help</string></llsd>


==Turn on/off Pathfinding==
Response:
    <llsd><string>Response</string></llsd>
=Turn on/off Pathfinding=
Must be estate power to do this: set dynamic_pathfinding [enabled|disabled]
Must be estate power to do this: set dynamic_pathfinding [enabled|disabled]
===Detailed instructions===
 
*To open the console type:  
<pre>CTRL + SHIFT + `  (CTRL + SHIFT + backtick) {{ENTER}}
( on a Keyboard with a UK Keymap use: CTRL + SHIFT + @ )
</pre>
*Turn off Pathfinding:
*Turn off Pathfinding:
<pre>
<pre>

Revision as of 12:25, 19 May 2013

The Command Console

The command console allows for a handful of region settings to be changed via text commands or http post operations from script.

You must be an estate manager to change the settings.

Commands

  • Help (Command)
    Help is available for the following commands and topics. Type "help <topic>" for more information.
    Note that all commands are case insensitive.

      Get                 Retrieve the value of a variable.
      Set                 Set the value of a variable.
      Unset               Returns a parameter to its built-in default. (Only available for certain parameters.)
      Parameters          List parameters you are authorized to view or modify.
      Restart             Restart the region after a specified amount of time (default 5mins)
  • Get (Command)
    Syntax: get <parameter>

      Retrieve the current value of a simulator or region variable. Note that if the variable was set since the region was restarted, the new value will be returned rather than the value used when the region started. This can be significant for some variables. For more information, see "help <variable>". To retrieve the value of a variable used at startup, use "get -s <variable>".
  • Set (Command)
    Syntax: set <variable> <value>

      Sets the value of a simulator or region variable. Note that some variable will not take effect until the region is restarted. This behavior will typically be specified in the parameter's description (see: "help variables")."

      Value Format Examples:
      Integer:  1234 or -435 0xffeb6194
      Float:    -3.4 or 14
      Bool:     [ON/OFF] or [TRUE/FALSE] or [ENABLED/DISABLED]
      Vector:   <1.34, -4.2, 8> in <x, y, z> order.
  • Unset (command)
Syntax: unset <parameter>

Sets a parameter to its built-in default. Not all parameters have defaults
  • Help Parameters (Command)
    Syntax: help parameters

     You are authorized to access the following parameters in this region:

     allow_return_encroaching_estate_object
     Allow land owners to return an Estate Manager's object that overlaps their land.
     Read/Write

     allow_return_encroaching_object
     Allow land owners to return a regular object that overlaps their land.
     Read/Write

     dynamic_pathfinding
     Enable/Disable pathfinding behaviors and navmesh updates. Requires a restart.
     Read/Write

     lures_obey_telehubs
     If true, teleport lures obey telehubs if they exist.
     Read/Write

     optimize_terrain
     Allows estate managers to disable certain terrain optimizations and is provided only for backward compatibility. Defaults to true (optimization enabled). Requires a terrain edit or sim restart to take effect.
     Read/Write

Note : The above commands are subject to change, so use 'help parameters' to determine the active ccommands for the current region.

  • Restart (Command)
    Syntax: restart <minutes>
      Restart the region after a specified amount of time (default 5mins).

Notes: Can only accept positive integers. If used during a active countdown will set the countdown to the specified time. Appears to have no throttling or wait timers. Giving the time "0" will cause the sim to shutdown immediately with no warning except for Second Life closing with a (Region is going down)

Restarts are warned to all clients with a message like this ([AlertMessage] /RESTART_X_MINUTES 5)

Notable Responses

If you stumble upon a variable or command not in help these two can show.

  • You are not authorized to set that parameter. This event has been logged.
  • You are not authorized to perform that command. This event has been logged.

To open the console

CTRL + SHIFT + `  (CTRL + SHIFT + backtick) {{ENTER}}
( on a Keyboard with a UK Keymap use: CTRL + SHIFT + @ )

LSL possibilities

If you have a bot with estate manager rights hand a LSL script the SimConsole Capability URL you can send commands to it. Note, you can't read the responses.

    llHTTPRequest("https://<YOUR REGION HOST>.agni.lindenlab.com:12043/cap/<YOUR CAP HERE>",[HTTP_METHOD,"POST"],"<llsd><string>set accurate_terrain FALSE</string></llsd>");

Capability Documentation

Post to Capability: "SimConsole"

Post:

   <llsd><string>help</string></llsd>

Response:

   <llsd><string>Response</string></llsd>

Turn on/off Pathfinding

Must be estate power to do this: set dynamic_pathfinding [enabled|disabled]

  • Turn off Pathfinding:
set dynamic_pathfinding disabled {{ENTER}}
restart {{ENTER}}
  • Turn on Pathfinding:
 
set dynamic_pathfinding enabled {{ENTER}}
restart {{ENTER}}

Beta_Server_Office_Hours/Minutes/2010-10-07