Difference between revisions of "Programmable Block"

From Space Engineers Wiki
Jump to: navigation, search
(Add some of the API)
m (categories)
 
(26 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
{{itembox
+
{{SimpleItembox|Mod:Vanilla/CubeBlock/LargeProgrammableBlock|Size||Mass||Integrity||BuildTimeSeconds||IsAirTight||ResourceSinkGroup||PCU}}
−
| item = Programmable Block
+
{{SimpleItembox|Mod:Vanilla/CubeBlock/SmallProgrammableBlock|Size||Mass||Integrity||BuildTimeSeconds||IsAirTight||ResourceSinkGroup||PCU}}
−
| description = Block That Executes Code
+
{{CategorizeComponents|Mod:Vanilla/CubeBlock/LargeProgrammableBlock}}
−
| tool = no
 
−
| largeship = yes
 
−
| smallship = yes
 
−
| component = no
 
−
| rawmaterial = no
 
−
| material = no
 
  
−
| sbuildtime = Unknown
+
== Overview ==
−
| scomponentstructure = 2
+
A Programmable Block can be programmed to do different functions, like switching lights and controlling doors. It can also be used by entering the control panel in the Terminal. It has almost unlimited functionality.
−
| scomponent1 = Steel Plate
 
−
| scomponent1amt = 2
 
−
| scomponent2 = Construction Component
 
−
| scomponent2amt = 2
 
−
| scomponent3 = Large Steel Tube
 
−
| scomponent3amt = 2
 
−
| scomponent4 = Motor
 
−
| scomponent4amt = 1
 
−
| scomponent5 = Computer
 
−
| scomponent5amt = 2
 
  
−
| lbuildtime = Unknown
+
== Usage ==
−
| lcomponentstructure = 2
+
Programmable Block scripts run in a single update (single frame) and any that take too long to complete are aborted. This means it is impossible for a single run of the script to 'wait' on any event. If you want your script to run when something happens, you need to either find a way of getting another block to trigger it at the right time (an 'interrupt-driven' approach via eg. a sensor block), or modify your script to check for a precondition and set up a timer to run it regularly (a 'polling' approach). Depending on what your script is doing, one approach may be the preferred or even the only way to do it.
−
| lcomponent1 = Steel Plate
 
−
| lcomponent1amt = 21
 
−
| lcomponent2 = Construction Component
 
−
| lcomponent2amt = 4
 
−
| lcomponent3 = Large Steel Tube
 
−
| lcomponent3amt = 2
 
−
| lcomponent4 = Motor
 
−
| lcomponent4amt = 1
 
−
| lcomponent5 = Computer
 
−
| lcomponent5amt = 2
 
  
−
| version = 01.063
+
*Since [[Update_01.067#Hotfix_01.067.007|Update 01.067 Hotfix 007]] each programmable block has a maximum limit of '''100,000''' characters for any in-game script.
−
}}
 
  
−
A Programmable Block can be programmed to do different functions, like switching lights and controlling doors. It can also be used by entering the control panel in the Terminal. It has almost unlimited functionality. One of the biggest problems is that variables are not saved between world exit and loading.
+
=== GUI Overview ===
  
−
== API List ==
+
The programmable block terminal panel screen currently contains two buttons:
  
−
This is a list of all API functions currently available<ref>http://steamcommunity.com/sharedfiles/filedetails/?id=360966557</ref>.
+
''Edit'' – it will open the editor for editing scripts and the ability to save/load scripts from and to disk.
 +
Also, you can upload your scripts to workshop and download subscribed scripts.
  
−
==== GridTerminalSystem ====
+
''Run'' – it will run the script that was remembered in editor. It will run the script only once. However this button is terminal action, so you can attach it to sensor, timer block, and button or add it to toolbar.
  
−
Currently only following “built-in” variable that user can use: GridTerminalSystem. This is entry point of entire grid terminal system.
+
[[File:Steamworkshop webupload previewfile 360966557 preview.jpg|500px]]
  
−
{| class="wikitable"
+
''Details section'' – In this area the script exception will be shown (if any will occur)
−
! Method/Property
+
 
−
! Return Type
+
==== Editor ====
−
! Description
+
{| style="width: 80%;"
−
|-
+
|
−
| Blocks
+
[[File:Steamworkshop webupload previewfile 360966557 preview (1).jpg|500px]]
−
| List<IMyTerminalBlock>
+
 
−
| Returns a list of all blocks on the grid
+
|Code editor contains these buttons:
−
|-
+
* ''Help'' – it will open the help guide inside the game.
−
| BlockGroups
+
* ''Check Code'' – it will check the code for code mistakes and also check if used code isn’t forbidden.
−
| List<IMyBlockGroup>
+
* ''Remember & Exit'' – it will save the code for execution, close editor screen and returns to terminal panel.
−
| Returns a list of all groups in the grid.
+
* ''Remember code'' – it will save code for execution and leave editor open.
−
|-
+
* ''Browse Workshop'' – it will open a window for script management, you can save/load scripts from disk , upload scripts to workshop and download subscribed scripts.
−
| GetBlocksOfType<T>(List<IMyTerminalBlock> blocks, Func<IMyTerminalBlock, bool> collect = null)
+
* ''Line counter'' – it shows current line number and total number of lines in code
−
| void
+
|}
−
| Puts all found blocks of provided type in the list that are connected to the grid
+
==== Browse Workshop ====
−
|-
+
{| style="width: 80%;"
−
| SearchBlocksOfName(string name,List<IMyTerminalBlock> blocks, Func<IMyTerminalBlock, bool> collect = null)
+
|
−
| void
+
[[File:Browse workshop.jpg|200px]]
−
| Puts all found blocks of provided name in the list that are connected to the grid
+
|This screen is similar to blueprint screen and contains these buttons :
−
|-
+
* ''Ok'' – it will load the selected script into the editor and close the screen
−
| GetBlockWithName(string name)
+
* ''Cancel'' – it will close the screen (no changes to code in editor)
−
| IMyTerminalBlock
+
* ''Details'' – it will open the "details" screen, where you can see description of script
−
| Returns a block with provided name
+
* ''Rename (only for local scripts)'' – it will rename the selected script, if you try to rename to existing script, the game will ask you if you want to overwrite the existing script.
 +
* ''Delete (only for local scripts)'' – it will ask you if you really want to delete the script, after the confirmation script will be deleted.
 +
* ''Create from editor''– it will create new script with default name Script_XX it starts with 0 and if the script with the selected name already exists, it will increment the value. E.g. first there will be Script_0 then Script_1 etc…
 +
* ''Replace from editor (only for local scripts)'' – it will replace (after user confirmation) the selected script with script from the editor.
 +
* ''Refresh Scripts'' – will reload the local and subscribed script list
 +
|}
 +
==== Details (local script) ====
 +
{| style="width: 80%;"
 +
|
 +
[[File:Details (local script).jpg|500px]]
 +
|This screen will show up when you press details for local script and contains the following buttons:
 +
* ''Rename'' – it will rename the selected script, if you try to rename to existing script, the game will ask if you want to overwrite the existing script.
 +
* ''Delete'' – it will ask you if you want to delete the script, after confirmation script will be deleted.
 +
* ''Publish'' – it will publish the script into workshop and show the workshop page with the script.
 +
* ''Browse Workshop'' – it will open the workshop screen to browse and subscribe scripts.
 +
* ''Close'' – it will close the screen
 
|}
 
|}
 +
==== Details (workshop script) ====
 +
 +
This screen will show up when you press details for script from workshop and it contains these buttons:
 +
* ''Open in Workshop'' – it will open the current script workshop page.
 +
* ''Close'' – it will close the screen
 +
 +
== Media ==
 +
[[File:Programmable_Block_ProgramBlock01.jpg|none|400px]]
 +
 +
== Tips ==
 +
 +
== Known Issues ==
 +
*'''Foreach not working at 64- bit''':
 +
''Problem'' - Currently using of foreach loop inside script will cause “bad program exception” at some configurations and prevent script from running. We are working of fixing this issue. <br/>''Workaround'' - All our interfaces used in in-game scripting are using lists as collections. Please use For loop for iteration across these lists
 +
 +
*'''Lambda functions not working'''
 +
''Problem'':
 +
Currently lambda functions are not supported, if you use them in script, exception will be thrown and script will not run.<br/>''Workaround'' -
 +
Please use method instead of lambda function if possible.
 +
 +
* '''User defined static variables and methods not working'''
 +
''Problem'' -
 +
Currently using user defined static members or methods will cause script to throw exception and the script will not run.<br/>''Workaround'' -
 +
Please don’t define static methods or variables.
  
−
==== IMyCubeBlock ====
+
*'''User defined variables are not saved'''
 +
''Problem'' -
 +
None of the user defined variables inside script are saved, therefore after loading game they are reset to their default values.<br/>''Workaround'' -
 +
We added string variable called "Storage" that will be loaded and saved when the block is loaded and saved.
  
−
IMyCubeBlock is base class for every terminal block.
+
== See Also ==
 +
* [[Programming Guide]]
 +
* [[Programming_Guide/Action_List|Action List]]
 +
* [[Programming_Guide/API_List|API List]]
  
−
{| class="wikitable"
+
== Programming ==
−
! Method/Property
+
* [[Programming_Guide/Action_List#Programmable_block|Action List - Programmable block]]
−
! Return Type
 
−
! Description
 
−
|-
 
−
| IsBeingHacked
 
−
| boolean
 
−
| Returns true if block is being hacked
 
−
|-
 
−
| IsFunctional
 
−
| boolean
 
−
| Returns true if current block is operational
 
−
|-
 
−
| IsWorking
 
−
| boolean
 
−
| Returns true if current block is powered
 
−
|-
 
−
| Position
 
−
| VRageMath.Vector3I
 
−
| Returns current position
 
−
|}
 
  
 +
== External links ==
 +
* Programmable block [https://github.com/malware-dev/MDK-SE/wiki/Quick-Introduction-to-Space-Engineers-Ingame-Scripts coding guide] - Malware's coding guide
  
 +
== Update History ==
 +
<div style="-webkit-border-image: none;-webkit-box-shadow: rgba(0, 0, 0, 0.046875) 0px 1px 1px 0px inset;background-color: #eeeeee;border-bottom-color: #AFAFAF;border-bottom-left-radius: 3px;border-bottom-right-radius: 3px;border-bottom-style: solid;border-bottom-width: 1px;border-left-color: #AFAFAF;border-left-style: solid;border-left-width: 1px;border-right-color: #AFAFAF;border-right-style: solid;border-right-width: 1px;border-top-color: #AFAFAF;border-top-left-radius: 3px;border-top-right-radius: 3px;border-top-style: solid;border-top-width: 1px;box-shadow: rgba(0, 0, 0, 0.046875) 0px 1px 1px 0px inset;color: #333;display: block;font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;font-size: 1em;height: auto;line-height: 20px;margin-bottom: 5px;margin-left: 8px;margin-right: 8px;margin-top: 0px;min-height: 20px;padding-bottom: 4px;padding-left: 4px;padding-right: 4px;padding-top: 4px;width: auto;">
 +
{| class="wikitable" style="width: 100%"
 +
|style="text-align: left;width: 8%"| [[Update 01.063]] ||style="padding-left: 10px;padding-right: 10px;"|
 +
* Programmable Block Introduced
 +
|}
  
−
<references />
+
</div>
 +
[[Category:Functional Blocks]]

Latest revision as of 22:37, 18 May 2020

Programmable Block Icon.png
Large Ship / Station
Programmable block
Large Ship Icon.png
ComponentsRequired
 Functional 
 Hack 
Dimensions (W,H,L)1,1,1
Mass534.4 kg
534,400 g
534,400,000 mg
0.534 t
Integrity2,387
Build time20 s
Is AirtightNo
Power Consumer GroupUtility
PCU Cost100
BrowseLast edit: 2020-04-13
Programmable Block Icon.png
Small Ship
Programmable block
Small Ship Icon.png
ComponentsRequired
 Functional 
 Hack 
Dimensions (W,H,L)1,1,1
Mass138.4 kg
138,400 g
138,400,000 mg
0.138 t
Integrity427
Build time8 s
Is AirtightNo
Power Consumer GroupUtility
PCU Cost100
BrowseLast edit: 2020-04-13

Overview

A Programmable Block can be programmed to do different functions, like switching lights and controlling doors. It can also be used by entering the control panel in the Terminal. It has almost unlimited functionality.

Usage

Programmable Block scripts run in a single update (single frame) and any that take too long to complete are aborted. This means it is impossible for a single run of the script to 'wait' on any event. If you want your script to run when something happens, you need to either find a way of getting another block to trigger it at the right time (an 'interrupt-driven' approach via eg. a sensor block), or modify your script to check for a precondition and set up a timer to run it regularly (a 'polling' approach). Depending on what your script is doing, one approach may be the preferred or even the only way to do it.

  • Since Update 01.067 Hotfix 007 each programmable block has a maximum limit of 100,000 characters for any in-game script.

GUI Overview

The programmable block terminal panel screen currently contains two buttons:

Edit – it will open the editor for editing scripts and the ability to save/load scripts from and to disk. Also, you can upload your scripts to workshop and download subscribed scripts.

Run – it will run the script that was remembered in editor. It will run the script only once. However this button is terminal action, so you can attach it to sensor, timer block, and button or add it to toolbar.

Steamworkshop webupload previewfile 360966557 preview.jpg

Details section – In this area the script exception will be shown (if any will occur)

Editor

Steamworkshop webupload previewfile 360966557 preview (1).jpg

Code editor contains these buttons:
  • Help – it will open the help guide inside the game.
  • Check Code – it will check the code for code mistakes and also check if used code isn’t forbidden.
  • Remember & Exit – it will save the code for execution, close editor screen and returns to terminal panel.
  • Remember code – it will save code for execution and leave editor open.
  • Browse Workshop – it will open a window for script management, you can save/load scripts from disk , upload scripts to workshop and download subscribed scripts.
  • Line counter – it shows current line number and total number of lines in code

Browse Workshop

Browse workshop.jpg

This screen is similar to blueprint screen and contains these buttons :
  • Ok – it will load the selected script into the editor and close the screen
  • Cancel – it will close the screen (no changes to code in editor)
  • Details – it will open the "details" screen, where you can see description of script
  • Rename (only for local scripts) – it will rename the selected script, if you try to rename to existing script, the game will ask you if you want to overwrite the existing script.
  • Delete (only for local scripts) – it will ask you if you really want to delete the script, after the confirmation script will be deleted.
  • Create from editor– it will create new script with default name Script_XX it starts with 0 and if the script with the selected name already exists, it will increment the value. E.g. first there will be Script_0 then Script_1 etc…
  • Replace from editor (only for local scripts) – it will replace (after user confirmation) the selected script with script from the editor.
  • Refresh Scripts – will reload the local and subscribed script list

Details (local script)

Details (local script).jpg

This screen will show up when you press details for local script and contains the following buttons:
  • Rename – it will rename the selected script, if you try to rename to existing script, the game will ask if you want to overwrite the existing script.
  • Delete – it will ask you if you want to delete the script, after confirmation script will be deleted.
  • Publish – it will publish the script into workshop and show the workshop page with the script.
  • Browse Workshop – it will open the workshop screen to browse and subscribe scripts.
  • Close – it will close the screen

Details (workshop script)

This screen will show up when you press details for script from workshop and it contains these buttons:

  • Open in Workshop – it will open the current script workshop page.
  • Close – it will close the screen

Media

Programmable Block ProgramBlock01.jpg

Tips

Known Issues

  • Foreach not working at 64- bit:

Problem - Currently using of foreach loop inside script will cause “bad program exception” at some configurations and prevent script from running. We are working of fixing this issue.
Workaround - All our interfaces used in in-game scripting are using lists as collections. Please use For loop for iteration across these lists

  • Lambda functions not working

Problem: Currently lambda functions are not supported, if you use them in script, exception will be thrown and script will not run.
Workaround - Please use method instead of lambda function if possible.

  • User defined static variables and methods not working

Problem - Currently using user defined static members or methods will cause script to throw exception and the script will not run.
Workaround - Please don’t define static methods or variables.

  • User defined variables are not saved

Problem - None of the user defined variables inside script are saved, therefore after loading game they are reset to their default values.
Workaround - We added string variable called "Storage" that will be loaded and saved when the block is loaded and saved.

See Also

Programming

External links

Update History

Update 01.063
  • Programmable Block Introduced
Retrieved from "http://spaceengineerswiki.com/index.php?title=Programmable_Block&oldid=25999"