This is a manual for a Ingame Script:
https://steamhost.cn/steamcommunity_com/sharedfiles/filedetails/?id=2610010357

This script allow you to control most of te terminal action on a lcd by mouse control and show the blocks information.

The Name PLC-OS stands for "Programmable Logic Controller - Operating System".
PLC are used in the electronic industry to automate and control operation.
Automation can be done by Logic Gates.

In this Manual we try to explain how to add item(s) to the screen(s), and how you can control/automate them.

Each line consists of one rule in the Customdata of the programmable block on which the script runs.

An extra Customdata of other blocks can be used as long the "ScreenTag"+[D] consists in block name

Thing that get added in line are Underlined

Enjoy.

Twotwinbrothers

• 1 Programmable block:
  This one will run this script
  
  Add "log" to Name of the program block to see log in the terminal (K)
  Add first three letter + "-" To Remove Log item Example: -SET (removes setting out of log)
  
  
• 1 Flight seat or Remote block
  If no tag is set, it wil use a rondom control seat
  
  
• 1 LCD panel(can be a lcd of other blocks to like Flight Seat, Sci fy Button panel or programmable blocks.)
  screentag+[screen name or number] must be set in the Name of the lcd Block

(note: the screens like the "Sci Fy Control panel" can't be use by scripts (KEEN didn't program these)

Type below in customdate to request current settings in the customdata:

settings

List below wil be shown whit changes made in translation strings in the customdata after reopening.
Its a quick way to get al the settings and tags in the customdata.

More about below tags in chapter: basic setup. (You wil see some of these tags there too.)


// itemname,+objectname = sets itemname, script only handle blocks whit itemname in it.
itemname,
// lcdtag,+lcdtag = sets first part of the lcdtag.
lcdtag,
// pittag,cockpit tag = name that the cockpit must contain.
pittag,
// remtag,remote tag = name that the remote must contain.
remtag,

// mouse,+screen = sets mouse to screen, mouse can't leave set screen.
mouse,Screen C
// mouse mode,true or false = if true mouse is shown on screen.
mouse mode,True
// park switch,true or false = if true mouse is shown on screen when park is on.
park switch,False

// sendfrom,channel name = set this PB IGC Channel Name.
sendfrom,
// sendto,channel name = set IGC Channel Name to send to, wen set you can't change it in script. sendto,Everyone

// sleep,+number = sets sleepmode timer, if set to 0 ,sleepmode is off.
sleep,0
// update,+1 or 100 = sets script updatetype, usefull for reading log.
update,Update1
// WSAD,+true or false = allows to put these characters directly into memory
WSAD,False

---

Everything after "//" is seen as an explanation is not run by the script.

Put // in front op a line it will switch off the line for the script until you remove the // again.
Some tags are not always needed, and should be switch off whit // .
Every line that is not a line recognise by the script should be behind //. Otherwise the script stop running whit al kinds of errors in the ditails window of the programmeble block terminal menu.

Type below in customdata to request al available commands in the customdata:

commands

List below wil be shown whit changes made in translation strings in the customdata after reopening. It just a quick way to get available commands in de customdata.

• add all,+tag = add tag to all blocks , even blocks after rotor en connectors.
  
• remove all,+tag = remove tag to all blocks , even blocks after rotor en connectors.
  
• add group,+tag = add tag to all blocks in group , even blocks after rotor en connectors.
  
• remove group,+tag = remove tag to all blocks in group , even blocks after rotor en connectors.

• lcdtag,screentag,surfacenumber,screenname,X,Y,-X,-Y = make an surface to write on and enable to set the resolution.
  X,Y, (resolution) -X,-Y (offset)
  if X,Y,-X,-Y = 0, it calculate and set the resolution and/or offset automatically.
  
• res,screenname = tels you the set or calculated resolution.

• link,screenname,memory,X,Y,Shape,H,B,°,screen to, new mouse X, new mouse Y, , , , ,
  
• output,screenname,memory,X,Y,Shape,H,B,°, text, Size, Name, typeQ, actionQ, typeE, actionE,
  
• input,screenname,memory,X,Y,Shape,H,B,°, text, Size, Name, type, , , ,
  
• object,screenname,memory,X,Y,Shape,H,B,°, text, Şize, R, G, B, status, ,

logic will be place in the memory start with LOGIC NAME and than the memory items divided with vertical bar "|".
[space]OR,NOR,XOR,XNOR,AND,NAND are suported.

Log of this script can be shown two ways.

• In details in te terminal (bottum right).
  
• On a lcd panel.

Add "log" to the name of the programmeble block where this script is running on.


Add the the line below to the customdata.



Add lcdtag+screentag to the lcd panell block name.

• COMBINED DATA
  
• COUNT
  
• SETTINGS
  • TAGS
    
  • CURRENT CONTROLER
    
  • MOUSE
    
  • ADDITIONAL
    
  • IGC
• IGC CHANNELS
  
• MEMORY
  
• LOGIC
  
• ERRORS

Log parts can be turn of by adding ("-" and first 3 capital letters of title) to the name of the programmeble block where this script is running on
That part wil not be shown in details or on the log screen.

Example: COMBINED DATA = "-COM"

From here we explane every log content


The Combined data exist out of parts from the customdata

1 Part 0 of the programmable block. (this will be updated each run)
2 Part that contains mouse lcd. (the screen the cursor is on will be updated )
3 Diverend part aech run. (the part that is updated is shown in log)

(note: if "yield" is not in the customdate. the customdata = Combined data)

To reduse the amount of instruction the programmable block have to exicute each run,
We can divide de customdata in parts by using the word "yield".

Wen do we yield

• after settings.
  
• before a new screen or screens are made.

It is important to keep an eye on the number of instructions. If this exceeds the maximum then the script will stop working. Grid with a lot of block with same ownership will result in a higher instruction count.

• total itemname blocks
  
• total controler blocks
  
• maximum instruction count
  
• current instruction count

• TAGS (part of Settings)
  
  List off the tags that will be shown.
  
  
  • itemname = shows itemname, tag if set
    
  • lcdtag = shows first part of the lcd Tag
    
  • pittag = shows cockpit tag, if set
    
  • remtag = shows remote tag, if set
  
  
• CURRENT CONTROLER
  
  
  • Controler = Selected controler that the script uses
    
  • Cockpit = Selected Cockpit
    
  • Remote = Selected Remote
  
  
• MOUSE (part of Settings)
  
  Shows current state of cursor
  
  
  • mouse lcd = Current lcd the cursor is shown on.
    
  • mouse mode true or false = When true mouse is shown.
    
  • park switch true or false = When true mouse is only shown when park is activated.
  
  
• ADDITIONAL
  
  
  • sleepmode timer = Shows countdown timer of the sleepmode.
    
  • Update freg. = update Speed in tiks
    
  • WSAD = use of keyboard Keys (true or False)
  
  Sleepmode turn the script off, run the prorammeble block turn the script back on.
  As long the cockpit or remote is occupide the timer wil not count down.
  By defauld sleepmode is off.
  
  
  
• IGC (Inter grid communication)
  
  • Sendfrom = Name of grid or the name hat has bin given.
    
  • Sentto = Channel that has been selected to sent to

• Shows All Grids/Channels that run this Script
  
• Sending Message:
  To:
  Date:
  From:
  Message delivered:

Every memory item + its value wil be shown in here.


The outcome of the logic will be shown here.
Begin with type of gate, then where it looks for followed by the result.


The current controlers will be shown here by name.


Shows the combined data line the error is found in.

Every block that you used whit this script need the itemname in is Name.


After closing the customdata it wil add "[item]'' is as the itemname to the script

The scrip wil look for this word in the name of the blocks. Make shore that the word isn't a word that is use often. For example the word "door" is a bad itemname, But door between backets [door] is better,

If you want to check if the right Itemname is set you can look the Log in the Details Window of the Program Block terminal Menu under -----SETTINGS-----

(Note: disconnect connectors first.)


After closing the customdata it will add "[item]" to every blocks name.

(Note: you can switch off a command by putting it behind // or by deleting from the Customdata.)



After closing the customdata it will remove "[item]'' form every blocks name.



After closing the customdata it will add "[item]" to every blocks name in group whit " group name ".



After closing the customdata it will remove "[item]'' from every blocks name in group whit " group name ".

You can run these commands in the argument field of the program block as well.

This script wil look at who is in control. This is needed for when the cockpit and remote is occupide at te same time. In that case the remote will control the cunsor, else the cockpit.



The Controller whit " [control]" in its Name will be seen as the cockpit.



The Controller whit " [remote]" in its Name will be seen as the remote.

If you want to check if the right contoller is set you can look in the Log in the Details window of the programmeble block terminal menu under: -----SETTINGS-----

LCD SET ARGUMENTS.

• lcdtag,tag = Sets screen tag is the same for every screen.
  
  
• lcdtag,screentag,surfacenumber,screenname,X,Y,-X,-Y = Make an surface to write on and enable to set the resolution.
  
  If X,Y,-X,-Y = 0, it calculate and set the resolution and/or offset automatically.
  X,Y, (resolution)
  -X,-Y (offset)

Each lcd tag starts with the lcdtag followed by indetifier(screentag).
surface nr is most of the time "0" only is a block have more then one surface it can be a other nr.
Later on i tel you how to get the surface nr.
screenname, is the indetifier we use in the lines we use to place item on screen.

• To set a Lcdtag
  
• Get surface nr
  
• Remove the screen numbers
  
• Create a surface

" [lcd]"is now the lcd tag.

iI the block have only one screen the surface number is "0" .

But cockpits and programmeble block have more than one surface
This script profide you whit a way to show surface number on the screens.

add lcdtag+[asterisk] in de Name of the block.
asterisk = *


the surface numbers are now displayed on every screen of that block.



Now that we have the surface number we can create a surface to place objects on


lcdtag,screentag,surfacenumber,screenname,X,Y,-X,-Y

For this example we give it names:


Place this line in the customdata

Place this line in the block name. you dont need to remove the name just add it

The screen should change to just an background color. If it does it connected to the script.
You can now place item on the screen. Whit commands in customdata: object, input, output, link.

To check if the mouse is working, place these line in the customdata.

After Closing customdata the script place the cunsor on "Screen 0" .

(Note: If this command is in Customdata, the cunsor can't leave the screen becase it is forced to above screen.put it behind // .


This wil set mouse mode to true .

After closing the Customdata the cunsor (the arrow on the screen) wil will be on the screen now.

You can switch de cunsor (Moude Mode) off by placing in behind //.

In the Log in de Details window of the programblock terminal under -----Mouse----- you can check the mouse mode status.

Note: The cunsor use the conttrol Gyro movement of the remote whit remtag or cockpit whit Pittag to move over the screen(s) And Q en E for Right en Left buttons. As log as the mouse mode is true your ship gyro can't move whit these control services.

The cunsor can now leave the surface if a link is placed.

Place in the G menu the programmable block (with this script ) on action "Run" with the argument "mouse".
Press it to activate or deactivate the mouse cursor.

by defauld this will be turn off.

when "Park" is on the cursor will be shown as well.
when "Park" is off the cursor get removed.

to turn off this behavore

to turn back on

(Note:This script disables the gyros for the cockpit or Remote block that your using at that moment.)

• on screen
  
• In the customdata

lcdtag,screentag,surfacenumber,screenname,X,Y,-X,-Y
Add "res" to screenname.

If you dont want to see resolution and offset any more, remove "res".

res,sreenname

In this example
screenname = Screen 0


Reopen customdata and "res,Screen 0" get replaced


X and Y are resolutie
-X and -Y is offset

surface

Small examples to place in the customdate after the surfacetag of the surface you want these objects on. Something to begin whit. To help you on your way.

Note: makes sure to "screenname" are the same..

PLC-OS Example Codes

To move the cunsor between screens we use te line start whit ''link''

link,screenname,memory,X,Y,Shape,H,W,°,screen to,new mouse X,new mouse Y, , , , ,


"new mouse X" and "new mouse Y" is the new location on the screen set in "screen to".
We can not use the auto calculate to determine the new location, That location must be set manually by number. (So no divide by number x number, like we did at X ,Y ,H and W ).

Disable the "mouse check" by putting // in front of it, if it not already done


for this example we need 2 surfaces, see chapter: Add Screens.
"screen 1" is below "screen 0".

Note: See that the link is place below the surface where you link from.

Now your cunsor should be able to move between "screen 0" to "screen 1" but not back.
So add another for the other screen.

Note: make sure that the cursor will not land on the other link.

Now your cunsor should be able to move between screens.

For this example we need 1 surfaces, see chapter: Add Screens.
Screen 0

To place an object to the screen we use:

object,screenname,memory,X,Y,Shape,H,W,°, text, Şize, R, G, B, status, ,

To place an output to the screen we use:
output,screenname,memory,X,Y,Shape,H,B,°, text, Size, Name, typeQ, actionQ, typeE, actionE,


1 output can activate 2 different action on the same block.

If Press "Q" on the keboard confirms actionQ.
typeQ must be specified for actionQ

If Press "E" on the keboard confirms actionE.
typeE must be specified for actionE

Example:

press "Q" wil activate "Block"
press "E" wil deactivate "Block"



if typeQ and typeE are the same, ActionQ will be executed when the cunsor moves over it.

Example:
Note: that agrument 12 (typeQ) and 14 (typeE) are the same as soon the cursor hits agrument 13 (actionQ) wil be executed, no need to place anything in argument 15(actionE).

Simple add (space) extra in typeQ prevent this.



This is possible. Moved to Chapter "Memory" for this you need to know how the "memory" works.

to place an input to the screen we use:
input,screenname,memory,X,Y,Shape,H,B,°, text, Size, Name, type, , , ,


This wil show onoff status of blocks that contains "Block" in there name.

In this Chapter i show you how to get a list of Action And Properties of a block and how to use them.






In this example, we'll turn on every block that contains "block" in its name.

Note: if you want te use an action out of the action list "type" must be "term".



For the property that are not supported See Type list - input
Most of the time i made a type for it

• Show whit Boolean(bool)Propery
  
  
  input,Screen 0, ,4|1,2|1,SquareFilled,1|1,2|1,0, ,0.4,block,bool|OnOFF, , ,
  
  In this example we'll show onoff status of every block that contains "block" in its name.
  Note: if you want te use an Boolean out of the property list "type" must be "bool"+"|"+"Boolean name".
  
  
• Set Boolean(bool)Property
  
  Boolean can be set by an action most of the time. no way to set it whit this script. Use the action.
  
  
• Show Single(float)Property
  
  
  input,Screen 0, ,4|1,2|1,SquareFilled,1|1,2|1,0, ,0.4,block,float|Radius|F0, , ,
  
  In this example we'll show "Radius" of every block that contains "block" in its name.
  Note: if you want te use an Single out of the property list "type" must be:
  "float" + "|" + "Single name"+ "|" + F0.
  
  F0 = no value after decimal marker.
  F1 = 1 value after decimal marker.
  F2 = 2 value after decimal marker.
  
  
• Set Single (float)Property
  
  
  output,Screen 0, ,8|7,2|1,SquareFilled,4|1,4|1,0, ,1,block,float ,Radius| |1, , , ,
  
  In this example we'll set the "Radius" + 1 of every block that contains "block" in its name.
  
  Note: if you want te use an action out of the action list "type" must be:
  "float" + "|" + "Symbool" + "|" + "number".
  
  Symbool can be :
  + = add nummer from value
  - = remove number from value
  (space) = set value to number
  
  
  
• Show Color Propery
  
  
  input,Screen 0, ,4|1,2|1,SquareFilled,1|1,2|1,0, ,0.4,block,color|Color, , ,
  
  In this example we'll show "Color" property of every block that contains "block" in its name.
  
  Note: if you want te use an action out of the action list "type" must be:
  "color" + "|" + "Color name".
  
  
• Set Color Propery
  
  
  output,Screen 0, ,8|7,2|1,SquareFilled,4|1,4|1,0, ,1,block,color ,Color|0|0|0, , , ,
  
  In this example we'll set the "Color"property to black(0|0|0|) of every block that contains "block" in its name.
  
  Note: if you want te use an action out of the action list "type" must be: "color"
  action: Color name + "|" + R + "|" + G + "|" + B. RGB must Between: 0-255

One menory item exist most of the time out of one line and out of two part

• Part 1: Is the memory name (Note: you can use a Space in memory name.)
  Separated by space
  
• Part 2: is the value or status ( only there if a Value or Status is set.)

You can search for memory items of the program block in the details window of the terminal menu under the headline -----MEMORY----- . that the place where the memory items are stored. Each memory item has it own line. ( see Chapter log )

This script allow you to add small part of text to memory string and check them.



When run again, it will remove the Memory Item.

(note: Only for checking this can be placed in the Customdata, everytime you close the Customdata this code wil be executed, More for Manual Use like buttons or hotbar. you can use this in the argument Field of programmable Block as well)



If "|" is added it wil split. "S0" is the name "P1" value or status.

First push, it add S0 and P1.
Second push, it removes P1.
Third push, it add P1 again.

If "|" is there, it replace the value or Status of the memory item.
If not it make another memory item if the value is different.

If "|" is not added it wil only Add "S0 P1"



Press Q "S0" has value "P1".
Press E "S0" value is change in "P2".
Press Q again "S0" has value "P1" again.


You have to give memory item a name. Add this in the argument Called "name" (argument 11 )divided "|".

The name we give the Memory item in this Example = BL
In "type"(argument 12) we have to set what to store. In this Example = term<#> = on/off Status

Remove memory item whit output.

In "TypeQ" (agrument 12) or "typeE" (argument 14) we place "mem-".
In "ActionQ" (agrument 13) or "ActionE" (argument 15) we place memory item we want to remove.


note: mem contains a minus after it.

When a input is use you can store that value that you have shown as text also to the memory

You have to give memory item a name. Add this in the argument Called "name" divided "|".

The name we give the Memory item in this Example = BL
In type we have to set what to store. In this Example = term<#> = on/off Status

In some cases you want to be able to clear the memory.

The memory get saved. Compiling the script will not clear it.

So how do we clear it than?

You can clear it whit "setput", just like you add one.



Note: there is a space before and after "cl",

In some cases you want the memory value to be positive instead of negative. or the other way around. The script can handle negetieve values to, so dont worry.


Example: S0 -100
It is a negetive value, we want it to be positive.


Example: S0 100

Note: "S0" has now a positive value.

for this you need to now how to use the Memory and is the first step to automation by the script

If typeQ contains "<auto>", ActionQ will be executed if memory contains agrument 2(memory)
If typeE contains "<auto>", ActionE will be executed if memory DONT contains agrument 2 (memory)
in argument 2 we can add a logic gate that compares multiply memory values

but for now we check only one value, in the example that is "hello" in the tirth line.

example:


in this example, a block named "Block" is enabled if the memory has "hello" in its memory, otherwise it is disabled

note: that as long the memory has Argument 2 in it ,agrument 13(actionQ) wil be executed,
else 15(actionE).

W S A D C SPACEBAR are the default movement keys on the keyboard. These are accessible by the programmable block.

This function must be turn on in the Customdata and is called "WSAD".
when false this turn off.
when true this in turn on.


SPACEBAR return as F in this script. This can be change in the translation string in the script editor in the game

If one of these keys will be pressed that key get stored (like: space + key + space) in the memory but will not be removed.
to remove it we add a line in the Customdata for every key we want to remove. In this Example it is: " W "


(Note: We place this line ones after the lines that does something whit " W ")

Most of the time i place these lines on the bottom of the Customdata. for every letter once

(Note: "Screen 0" must be a screen name that exist)


In "memory" (argument 2) we place the letter ( W )whit the space before and after it.
In "TypeQ" (agrument 12) or "typeE" (argument 14) we place "<auto>" to automate the line.

In the example above when pressing W the velocity of all blocks called "Piston" wil change to "0.5" (Plus)

In the example above when pressing " S " the velocity of all blocks called "Piston" wil change to "-0.5" (Min)

In the example above both " W " and " S " in not used the velocity of all blocks called "Piston" wil change to "0".
In this case we already used a logic gate that we try to explane in the next chapter.

(Note: If there a block called "Piston" that do not know the terminal action 'Velocity" the script wil stop working. In that case you should change the blockname and recompile the script).

Logic Gates are place in the memory part of a line.

In this chapter i wil show how to use them.

It will always begin whit the type of Logic Gates followed by "|".
After "|" you will place what it have to look for in the memory.
This can be repeated.
You can't use two different gates in one line.

Every memory item wil return "1" or ''0''.
If memory item is there it wil "1".
If memory item is not there it wil "0".

the outcom of the logic is visable in the log shown in Terminal(K).
when "log" is placed in the programmeble block Name.

Depending on what Gate is used, the line will be displayed or is usable.

Note: make sure there is a space before the Gate name.

We can do this by placing "=",">" or "<" between memory name and value or another memory name.

">" is smaller then memory item in front of it
"<" is bigger then memory item in front of it
"=" is the same as memory item in front of it

This will only work whit numbers.
Also we have to tell which gate we want to use.

in de memory we have 1 memory items whit name "G1".

G1 60



If G1 is bigger than 100 this wil return a "1" and because we use a OR gate, "S3 P1" wil be place in the memory.

In our example this is not he case so "S3 P1" will not be place in the memory.

In de memory we have 2 memory items whit names "G1" and "G2"

G1 60
G2 80



If G1 is smaller than G2 this wil return a "1" and because we use a OR gate, "S3 P1" wil be place in the memory. In our Example this is the case.

This script allow to get info(some kind of webpage)form another programeble block (PB) whit this same script on it.

• You need at lease 2 PB.
  (Note: they don't need to be on te same grid. But need to be connected by antenne or mechanical connection)
  
• Ownership must be in the same faction.

Now you need to set a Channel Name for every PB.
(Note:these may not contain the name of te other.)

sendfrom,channel name

For this example we name te chanels like:
PB 1= Main Station
PB 2= Small ship

PB 1
PB 2

(Note: script in "sleepmode" can not receive anything. we turn of sleepmode by adding "sleep,0")

The channel to sent to can be set as well.
(Note: wen set you can't change it in script)

sendto,channel name
PB 2

There are to way to see wat has been send or resieved.

• in the log under -----IGC CHANNELS-----
  This shows the channels.
  Under it shows last massege sent or resieved.
  
• on a surface.

We make a surface for each PB.

iIn "type" (argument 12) we add "com <to> <list>".

• com = type
  
• <to> = get replaced by channel to sent to.
  
• <from>= get replaced by channel to sent from.
  
• <list> = get replaced bij list of channel known and last
  resieved message

PB 1
(Note:dont forget to add the "itemname" and the "lcdtag+screentag" to the block name)

PB 2

lets send the text "Hello" from PB 2 to PB 1 as test

Can be done 2 ways.

• Via Pb "Run" whit argument "Hello".
  
  
• In the CustomData by placing an output.

In this example we add an output
in "typeQ" (argument 12) we place "com".
in "ActionQ" (argument 13) we place the message want to sent.

Note: we have placed a second message in "typeE" "ActionE" .

PB 2
Push the button on de surface will sent the the text "hello".

if done right the follow messege wil appaer:
PB 1
PB 2

The lines below wil show some kind of browser
With which you can find and browse channels.
With the button "go" we ask to show information stored (web) on the channel of your choice
not every PB have info stored.


(note: To be able to cycle through the channels "sendto" must be deactivated)

We can store info by adding "web" instead of "screenname"


In this above example we have small base whit 1 airvent and 2 doors.

Note that the input has "conv" instaed of "web". it converts the input to object whit the status of the input. if requested it wil send the output and object to the requesting PB.

The requesting PB can interact whit it. Opening Door 1, 2 and de/pressurize the Airvent Base.

(Note: dont forget to put "<send Q>" and "<send E>" so it can be send back.)

This script is still a work in progress.

If you want make a movie or serie about it, we will make some free time for it, We tried, but our setup wasn't really made for it. The sound was really bad.

We have not yet discussed everything in this manual, so if you have any questions, ideas or suggestions, we would like to hear them.

Enjoy

Twotwinbrothers