Space Engineers

Space Engineers

243 ratings
[TMC] Tree Menu Command NET
4
2
4
3
   
Award
Favorite
Favorited
Unfavorite
File Size
Posted
Updated
464.070 KB
Apr 4, 2022 @ 11:13am
May 20 @ 12:42pm
11 Change Notes ( view )

Subscribe to download
[TMC] Tree Menu Command NET

Description
Description
This script provides graphical interface to terminal block actions in the form of tree-organized menu.
Originally intended to help organizing complex builds with many programmable blocks that require numerous command arguments. Helps a lot to save toolbar space and removes the need to remember button meanings. Also it helps by grouping commands as you see fit.



This script is an evolution of Tree Menu Command.

Distinctive features:
  • Works as a self-configurable network, where any menu instance can be remotely controlled from another one.
  • GUI can be controlled by mouse or conventional toolbar commands
  • Easy single Custom Data config - space-indented tree hierarchy
  • Programmable Block argument calls with result printout
  • Grid timers are grouped into the separate menu entry
  • foreach, group and name-bound queries for terminal block triggers and properties
  • report query for discovering API type names and available API terminal actions and properties
  • dynamic menu population callbacks for supported scripts (i.e. HudDog automatically feeds its' toggle entries)

Setting up
Build
1. Get the script into PB.
2. Add PB to some group (name does not matter).
3. Optional - add cockpit or remote to the same group (not needed for remote-controlled instances)
4. Optional - LCD panel to the group or set cockpit internal screen index for the main GUI output (not needed for remote-controlled instances). Cockpit screen index is MenuScreenIndex field found at the top of the code.
5. Optional - add timer blocks that you want to appear in Timer Triggers menu entry.
6. Optional - add welder or grinder to the script group and use it from toolbar to capture mouse click - alternative for E button.
7. Optional - add Action Relay block to the script group (new feature, see below).
7. Set the PB Custom Data (optional, but without it you get only Timers menu entry activation).

Check out Config class at the top of the code, there is some minor convenience stuff to customize.

Custom Data
The structure is defined in PB custom data (single space indent defines the level of hierarchy).

Programmable block trigger with argument

The 1st level elements must be a part of the name of the target programmable block. I.e. if you want to attach commands to PB named "a-processing-core [drone][clock=12]" the element can be named "core".
The last (downmost) element must be the actual command line, which will be passed to respective PB.

Optionally a line can start with DisplayName parameter. Put it in front of an existing command, dot-comma-delimited, to have your text displayed instead of actual command string. Like this:
DisplayName=my pretty string;command:recycle.
That of course bans using dot comma in that text alias, but if you really need that, you can change AliasDelimiter value at the top of the script.

TMC can dynamically populate menu nodes by pulling data from other scripts. See this guide for details.

General block action trigger

Actions represent triggers that you can do in timer blocks.

Templates:
  • foreach:IType:Action - runs Action for all blocks of IType (foreach:MyBatteryBlock:OnOff)
  • first:name:Action - runs Action for the first block it finds that has {name} it its' CustomName (first:Projector 2:IncreaseY)
  • group:name:Action - tries to run Action for all blocks in a group specified by name (group:Dakka:Shoot_On)
  • report:name - searches block by name, prints its' type name and available Actions to PB log (found in secondary PB screen, aka "keyboard")

General block set property value

Properties represent values that you set in terminal UI (i.e. Velocity for pistons and rotors, Color for lights, etc). Vanilla does not offer any kind of automation for these, only direct user input in interface.

To set property:
foreach:IType:ProperyId:Value
first:name:ProperyId:Value
group:name:ProperyId:Value

Value can be of 3 types:
number
bool (true, false)
Color (6-digit hex number, like in games' color picker. E.g.: #ff11aa)

To increase or decrease current value, prefix it with a $, for example:

group:Rotors:Velocity:$-0.5
first:Battery:OnOff:$

For numeric values, $ would take current value and add yours. For booleans (true/false), which are used for On/Off properties, $ would invert the current value. Note that there is an Action OnOff on most blocks that would do essentially the same as set Property (first:Battery:OnOff:$), but that isn't always available.

To find out Type, Actions and Properties of certain block type, name your block in a unique way and then make menu entry report:{that block name}. Recompile, navigate to that entry and run it. Then look to PBs' screen (keyboard) and get them from log output.

Multiple queries in one trigger

Query batches - compose multiple queries in a single menu item like this: [query1],[query2],...,[queryN]

Query by argument run

Run the PB with argument "q:{your_block_query}" to have that query executed immediately without using menu. That allows to use TMC as a query runner from timers or toolbar.

Timer trigger

All grid timers are found in special menu entry. Just navigate there and use them.

Action Realy command binding

You can have action relay set channel action trigger commands. The idea is to have labeled actions on toolbar until Keen decides to implement the labeling feature for PB run action.

1. Add AR block to the group
2. Add SetChannel actions to your toolbar and label them nicely
3. Add command bindings to a "Transponder" subsection. Example:

my block queries projector offsets first:Projector 2:DecreaseZ transponder 5:first:RotorX:Velocity:-30 7:first:RotorX:Velocity:10 2:first:LightX:Color:#ff0000

Using it

To toggle mouse capture, run PB with argument 'cc' (Capture Controls). Move mouse around, use E key as Enter, Q as Escape.

Alternatively, use 'up', 'down', 'esc', 'enter' args from toolbar to navigate and run without losing rotation controls of your grid.

After any changes to Custom Data, recompile the script.

To change "Context" press those small triangles besides Local caption, or use 'ctn' and 'ctp' arguments (ContextNext, ContextPrevious).

Local means that all is meant to be ran at your current grid, using its' Custom Data menu definition. If you have more than one grid with this script, you can change context to run commands on the different grid (using that grids' menu definition). So, another grid can have totally different menu contents, and you'll get them pulled to your local screen, like in WWW client-server stuff.

In the following example if I go min3r->docking->command:force-finish the code would try to invoke my PB named "SCAM-or-whatever-min3r" with argument "command:force-finish".

Example here.
Popular Discussions View All (4)
31
Jan 29, 2023 @ 11:09am
Suggestions
cheerkin
27
Dec 12, 2022 @ 12:53pm
Bug reports
cheerkin
0
May 20 @ 1:02pm
Sample custom data definition
cheerkin
87 Comments
cheerkin  [author] Dec 21, 2023 @ 2:48am 
Good suggestion, I'll think about adding such feature.

Guys, please put your suggestions in the discussion so they could be noticed better.
Stollie Dec 19, 2023 @ 8:01am 
Hi, sometimes I cant tell if a command has actually been 'pushed' is there a way to provide more feedback when you select an item? Like a flash or a sound etc.?
cheerkin  [author] Dec 3, 2023 @ 3:14pm 
Maybe, noted.
Badwolff101 Dec 2, 2023 @ 8:02am 
Any chance you could get this to work with the new inset button panel?
cheerkin  [author] Apr 17, 2023 @ 6:26pm 
All at once - no. You can do it one by one, using context switching feature. That's if you mean vanilla automaton drones.
Tori Apr 17, 2023 @ 5:52pm 
Is there a way i could use this script on a capital ship to command all drones to return to the ship?
Tuchevery Feb 20, 2023 @ 11:31am 
I love this script. I put a control seat on a rotor and now I can control everything on my base from one seat.
cheerkin  [author] Jan 15, 2023 @ 1:10pm 
Yep, there are two ways of running PB with arg. You're welcome!
royalrollin Jan 14, 2023 @ 7:36am 
Hello cheerkin,
It works also: (like you scripts)
"
PowerControl
menu=1
menu=2
"
and gives DisplayOutput to TMC. Zhis works with PowerControl and H2O2Control(v0.6) by Alfromeo80. Just for info...

I´m very happy with it! Thanks you!:steamthumbsup:
cheerkin  [author] Jan 13, 2023 @ 6:08am 
Year, but separate parts in a proper way
DisplayName=Select;first:PB PowerControl:Run:{argument}