SHART | Script Handling Activation of Remote Timers

[img=https://i.imgur.com/iHy45ds.png]

  Description

Howdy!

This script allows you to trigger timers on other ships/stations that also have this script using antennas. This script can also act as both a sender and receiver.

[img=https://i.imgur.com/iHy45ds.png]

  Features

• Triggers timers on other ships using antenna-based communication
• A single script can be used send/receive timer trigger requests
• Animated send/receive indicator
• 
• New! - Can tie multiple timers to a single SHART!

[img=https://i.imgur.com/iHy45ds.png]

  Setup Instructions

[olist] [*] Place this script in a programmable block. [*] Place a timer block. [*] Place at least one regular antenna or laser antenna.

• Laser antenna need to actually be linked to another laser antenna to work

[*] Open the Custom Data of the programmable block and set "Timer to trigger on receive" to the name of a timer block. This timer will get triggered when a SHART message is received.

• You only need to do this if you want to be a receiver. Senders are not required to have a timer configured.

[*] Recompile the script once you are done configuring. [/olist]

Note: You must recompile the script to process any setup changes.

[img=https://i.imgur.com/iHy45ds.png]

  Usage Instructions

When the script is compiled for the first time, your script gets assigned a randomly generated (and likely silly) name tag called a UID (Unique Identifier). The UID is sort of like the "address" for a programmable block. The UID is what other SHART scripts will use to send messages to this particular programmable block through the antenna network.

If you do not like the automatic Unique ID generated for you, you can change it in the Custom Data, then recompile.

Subaddresses

In the custom data of SHART, you can now configure a list of "subaddresses" which allows you to trigger different timers with a single programmable block.

If a subaddress is specified for an incoming SHART message, the script will trigger the timer associated with that subaddress (if it exists). You do not need to use subaddresses if you do not want to.

In the custom data, subaddress entries must be on their own line and in the form:

|<subaddress>,<exact timer name>[/code]

[h3]Example[/h3]
[code]
Receive timer subaddresses=
|primary,Timer Block 1
|secondary,Timer Block 2
|tertiary,Timer Block 3

Note: Subaddress names are whitespace sensitive. If you add whitespace after the comma or leave trailing whitespace after the name, it will be treated as part of the name. The subadddress snippit: "|primary, Timer Block 1" will process the name as " Timer Block 1" not "Timer Block 1".

Sending

To be able to successfully send a request, you must be able to reach the desired SHART program via using laser antenna or regular antenna. Messages will be automagically routed through the antenna network to reach the desired SHART program.

Also, it is worth noting that only allied antennas can receive your messages.

The argument

trigger UniqueIdGoesHere

will send a trigger command to the SHART program with the specified Unique ID.

The argument

start UniqueIdGoesHere

will send a start command to the SHART program with the specified Unique ID.

The argument

stop UniqueIdGoesHere

will send a stop command to the SHART program with the specified Unique ID.

To send a SHART message to a particular UID, you simply append the subaddress to the end of the above arguments. For example:

trigger UniqueIdGoesHere SubAddress

Receiving

To receive a request, you need to have an antenna (laser or regular) on your ship to receive messages with. You do not need to broadcast to be able to receive messages, so you can have stealthy receiver antennas that just listen for remote requests.

You also need to have a valid timer assigned to this program. You can configure the name of the desired timer in the Custom Data of the SHART programmable block.

When SHART receives a "trigger", "start", or "stop" message, it will perform the corresponding action on the assigned timer. If a subaddress is specified, the timer associated with that subaddress will also be triggered accordingly.

[img=https://i.imgur.com/iHy45ds.png]

  Arguments

[table] [tr] [th]Argument        [/th] [th]Description[/th] [/tr] [tr] [td]trigger UID[/td] [td]Sends trigger command to a SHART program with the specified Unique ID (UID).[/td] [/tr] [tr] [td]trigger UID SUBADDRESS[/td] [td]Sends trigger command to a SHART program with the specified Unique ID (UID) and triggers the timer associated with the subaddress (if valid).[/td] [/tr] [tr] [td]start UID[/td] [td]Sends start command to a SHART program with the specified Unique ID (UID).[/td] [/tr] [tr] [td]start UID SUBADDRESS[/td] [td]Sends start command to a SHART program with the specified Unique ID (UID) and starts the timer associated with the subaddress (if valid).[/td] [/tr] [tr] [td]stop UID[/td] [td]Sends stop command to a SHART program with the specified Unique ID (UID).[/td] [/tr] [tr] [td]stop UID SUBADDRESS[/td] [td]Sends stop command to a SHART program with the specified Unique ID (UID) and stops the timer associated with the subaddress (if valid).[/td] [/tr] [tr] [td]rename[/td] [td]Creates a new randomized Unique Identifier for this SHART program.[/td] [/tr] [/table]

[img=https://i.imgur.com/iHy45ds.png]

  FAQ

Can I customize the Unique ID of my program?