Difference between revisions of "ISUplink:Relay (Command)"

From Lavish Software Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Syntax ==
 
== Syntax ==
 
relay <uplink name|session name|all|all local> [-echo|-event <name>|-noredirect] <message|command>
 
relay <uplink name|session name|all|all local> [-echo|-event <name>|-noredirect] <message|command>
 +
 +
Note: To send a command to your local uplink, use the uplink command.
  
 
== Description ==
 
== Description ==
Line 13: Line 15:
 
*Relay is1 "Press 1"
 
*Relay is1 "Press 1"
 
: From the uplink
 
: From the uplink
*Uplink Relay is1 "Press Alt+F1"
+
*Relay is1 "Press Alt+F1"
 
: From a session
 
: From a session
 
*Relay all -echo "Hi"
 
*Relay all -echo "Hi"
 
*Relay "all local" -echo "Hi"
 
*Relay "all local" -echo "Hi"
*Relay remotesystem.is1 runscript wowbot/wowbot
+
: Relaying a ''single-parameter'' event execution
: Relaying events
+
*Relay all -event EVENT_NAME Param1
*(from script) Relay all -event EVENT_NAME Param1
+
: Relaying a multi-parameter event execution
*(from uplink) Uplink Relay all -event EVENT_NAME Param1
+
*Relay all "Event[EVENT_NAME]:Execute[param1,param2,\"param3 has quotes\"]"
  
 
== See Also ==
 
== See Also ==

Latest revision as of 15:23, 15 December 2018

Syntax

relay <uplink name|session name|all|all local> [-echo|-event <name>|-noredirect] <message|command>

Note: To send a command to your local uplink, use the uplink command.

Description

Relays a command to a given session. This is asynchronous -- the command is not guaranteed to have executed in the given session by the time this command completes. If "all" is used, the command is broadcast to all sessions (including remote). If "all local" is used, the command is broadcast to all local sessions.

Note

From Lax: When you relay, the output of the command is sent to the sender, not displayed on the remote session. The -noredirect switch makes it so the output is displayed on the remote session

The uplink's name, is the same as the system-name. The system-name can be read with ${SettingXML[InnerSpace.XML].Set[Remote].GetString[Name].Escape}

Examples

  • Relay is1 "Press 1"
From the uplink
  • Relay is1 "Press Alt+F1"
From a session
  • Relay all -echo "Hi"
  • Relay "all local" -echo "Hi"
Relaying a single-parameter event execution
  • Relay all -event EVENT_NAME Param1
Relaying a multi-parameter event execution
  • Relay all "Event[EVENT_NAME]:Execute[param1,param2,\"param3 has quotes\"]"

See Also