Skip to content

Commit 745a956

Browse files
MerlinofMinesMerlinofMines
committed
Added docs for Hydrogen Engines, Reactors, Solar Panels, and Wind Turbines
1 parent 16da9b1 commit 745a956

File tree

6 files changed

+320
-3
lines changed

6 files changed

+320
-3
lines changed

‎EasyCommands/BlockHandlers/BlockHandlers.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ public static class BlockHandlerRegistry {
2525
{ Block.DECOY, new FunctionalBlockHandler<IMyDecoy>() },
2626
{ Block.DETECTOR, new OreDetectorHandler() },
2727
{ Block.DISPLAY, new TextSurfaceHandler() },
28-
{ Block.DRILL, new FunctionalBlockHandler<IMyShipDrill>() },
2928
{ Block.DOOR, new DoorBlockHandler() },
29+
{ Block.DRILL, new FunctionalBlockHandler<IMyShipDrill>() },
3030
{ Block.EJECTOR, new EjectorBlockHandler() },
3131
{ Block.ENGINE, new EngineBlockHandler<IMyPowerProducer>("Engine") },
3232
{ Block.GEAR, new LandingGearHandler() },
@@ -47,6 +47,7 @@ public static class BlockHandlerRegistry {
4747
{ Block.PROJECTOR, new ProjectorBlockHandler() },
4848
{ Block.REACTOR, new EngineBlockHandler<IMyReactor>() },
4949
{ Block.REMOTE, new RemoteControlBlockHandler()},
50+
{ Block.REFINERY, new FunctionalBlockHandler<IMyRefinery>() },
5051
{ Block.ROTOR, new RotorBlockHandler(b => !IsHinge(b)) },
5152
{ Block.SOLAR_PANEL, new EngineBlockHandler<IMySolarPanel>() },
5253
{ Block.SORTER, new SorterBlockerHandler() },
@@ -60,8 +61,7 @@ public static class BlockHandlerRegistry {
6061
{ Block.TURBINE, new EngineBlockHandler<IMyPowerProducer>("WindTurbine") },
6162
{ Block.TURRET, new TurretBlockHandler<IMyLargeTurretBase>()},
6263
{ Block.WARHEAD, new WarheadBlockHandler() },
63-
{ Block.WELDER, new FunctionalBlockHandler<IMyShipWelder>() },
64-
{ Block.REFINERY, new FunctionalBlockHandler<IMyRefinery>() }
64+
{ Block.WELDER, new FunctionalBlockHandler<IMyShipWelder>() }
6565
};
6666

6767
public static BlockHandler GetBlockHandler(Block blockType) {

‎docs/EasyCommands/blockHandlers.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,10 +163,14 @@ Also check out [Items & Blueprints](https://spaceengineers.merlinofmines.com/Eas
163163
* [Drills](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/drill "Drill Handler")
164164
* [Ejectors](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/ejector "Ejector Handler")
165165
* [Grinders](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/grinder "Grinder Handler")
166+
* [Hydrogen Engines](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/engine "Hydrogen Engine Handler")
166167
* [Inventories](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/inventory "Inventory Handler")
167168
* [Laser Antenna](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/laserAntenna "Laser Antenna Handler")
168169
* [Ore Detectors](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/detector "Ore Detector Handler")
170+
* [Reactors](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/reactor "Reactor Handler")
169171
* [Refineries](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/refinery "Refinery Handler")
170172
* [Remote Controls](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/remote "Remote Control Handler")
173+
* [Solar Panels](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/solar "Solar Panel Handler")
171174
* [Terminal Blocks](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/terminal "Terminal Block Handler")
172175
* [Welders](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/welder "Welder Handler")
176+
* [Wind Turbines](https://spaceengineers.merlinofmines.com/EasyCommands/blockHandlers/turbine "Wind Turbine Handler")

‎docs/EasyCommands/blockHandlers/engine.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Hydrogen Engine Block Handler
2+
3+
This Block Handler handles Hydrogen Engines. It can be used to turn on/off the Hydrogen Engine and get information about its energy output
4+
5+
* Block Type Keywords: ```engine```
6+
* Block Type Group Keywords: ```engines```
7+
8+
Default Primitive Properties:
9+
* Bool - Enabled
10+
11+
## "Enabled" Property
12+
* Primitive Type: Bool
13+
* Keywords: ```enable, enabled```
14+
* Inverse Keywords: ```disable, disabled```
15+
16+
Enables or Disables the given block
17+
18+
```
19+
#Enable Block
20+
enable "My Hydrogen Engine"
21+
set "My Hydrogen Engine" to enabled
22+
turn on "My Hydrogen Engine"
23+
24+
#Disable Block
25+
disable "My Hydrogen Engine"
26+
set "My Hydrogen Engine" to disabled
27+
turn off "My Hydrogen Engine"
28+
```
29+
30+
## "Power" Property
31+
* Primitive Type: Bool
32+
* Keywords: ```power, powered```
33+
34+
Turns on or off power to the block. Effectively the same as the Enabled property.
35+
36+
```
37+
#Turn on
38+
turn on power to "My Hydrogen Engine"
39+
power on "My Hydrogen Engine"
40+
41+
#Turn off
42+
turn off "My Hydrogen Engine"
43+
power off "My Hydrogen Engine"
44+
```
45+
46+
## "Output" Property
47+
* Read-only
48+
* Primitive Type: Numeric
49+
* Keywords: ```output, outputs```
50+
51+
Gets the current energy output, in MW.
52+
53+
```
54+
Print "Energy Output: " + "My Hydrogen Engine" output
55+
```
56+
57+
## "Limit" Property
58+
* Read-only
59+
* Primitive Type: Numeric
60+
* Keywords: ```limit, limits```
61+
62+
Gets the maximum energy output the hydrogen engine is capable of, in MW.
63+
64+
```
65+
Print "Maximum Output: " + "My Hydrogen Engine" limit
66+
```
67+
68+
## "Ratio" Property
69+
* Read-only
70+
* Primitive Type: Numeric
71+
* Keywords: ```ratio, ratios, percent, percents, percentage, percentages```
72+
73+
Returns a value between 0 - 1 representing the current output over the maximum output. For Hydrogen Engines, will typically be 0 if off or unfueled and 1 if on and fueled.
74+
75+
```
76+
Print "Output Ratio: " + "My Hydrogen Engine" ratio
77+
```

‎docs/EasyCommands/blockHandlers/reactor.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Reactor Block Handler
2+
3+
This Block Handler handles Reactors. It can be used to turn on/off the Reactor and get information about its energy output
4+
5+
* Block Type Keywords: ```reactor```
6+
* Block Type Group Keywords: ```reactors```
7+
8+
Default Primitive Properties:
9+
* Bool - Enabled
10+
11+
## "Enabled" Property
12+
* Primitive Type: Bool
13+
* Keywords: ```enable, enabled```
14+
* Inverse Keywords: ```disable, disabled```
15+
16+
Enables or Disables the given block
17+
18+
```
19+
#Enable Block
20+
enable "My Reactor"
21+
set "My Reactor" to enabled
22+
turn on "My Reactor"
23+
24+
#Disable Block
25+
disable "My Reactor"
26+
set "My Reactor" to disabled
27+
turn off "My Reactor"
28+
```
29+
30+
## "Power" Property
31+
* Primitive Type: Bool
32+
* Keywords: ```power, powered```
33+
34+
Turns on or off power to the block. Effectively the same as the Enabled property.
35+
36+
```
37+
#Turn on
38+
turn on power to "My Reactor"
39+
power on "My Reactor"
40+
41+
#Turn off
42+
turn off "My Reactor"
43+
power off "My Reactor"
44+
```
45+
46+
## "Output" Property
47+
* Read-only
48+
* Primitive Type: Numeric
49+
* Keywords: ```output, outputs```
50+
51+
Gets the current energy output, in MW.
52+
53+
```
54+
Print "Energy Output: " + "My Reactor" output
55+
```
56+
57+
## "Limit" Property
58+
* Read-only
59+
* Primitive Type: Numeric
60+
* Keywords: ```limit, limits```
61+
62+
Gets the maximum energy output the reactor is capable of, in MW.
63+
64+
```
65+
Print "Maximum Output: " + "My Reactor" limit
66+
```
67+
68+
## "Ratio" Property
69+
* Read-only
70+
* Primitive Type: Numeric
71+
* Keywords: ```ratio, ratios, percent, percents, percentage, percentages```
72+
73+
Returns a value between 0 - 1 representing the current output over the maximum output.
74+
75+
```
76+
Print "Output Ratio: " + "My Reactor" ratio
77+
```

‎docs/EasyCommands/blockHandlers/solar.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Solar Panel Block Handler
2+
3+
This Block Handler handles Solar Panels. It can be used to turn on/off the Solar Panel and get information about its energy output
4+
5+
* Block Type Keywords: ```solar```
6+
7+
While there is no Block Type Group word for Soloar Panels, the keyword "panels" implies you are referring to a group. So the following will turn on all Solar Panels in the "My Solar Panels" group.
8+
9+
```
10+
turn on "My Solar Panels"
11+
```
12+
13+
Default Primitive Properties:
14+
* Bool - Enabled
15+
16+
## "Enabled" Property
17+
* Primitive Type: Bool
18+
* Keywords: ```enable, enabled```
19+
* Inverse Keywords: ```disable, disabled```
20+
21+
Enables or Disables the given block
22+
23+
```
24+
#Enable Block
25+
enable "My Solar Panel"
26+
set "My Solar Panel" to enabled
27+
turn on "My Solar Panel"
28+
29+
#Disable Block
30+
disable "My Solar Panel"
31+
set "My Solar Panel" to disabled
32+
turn off "My Solar Panel"
33+
```
34+
35+
## "Power" Property
36+
* Primitive Type: Bool
37+
* Keywords: ```power, powered```
38+
39+
Turns on or off power to the block. Effectively the same as the Enabled property.
40+
41+
```
42+
#Turn on
43+
turn on power to "My Solar Panel"
44+
power on "My Solar Panel"
45+
46+
#Turn off
47+
turn off "My Solar Panel"
48+
power off "My Solar Panel"
49+
```
50+
51+
## "Output" Property
52+
* Read-only
53+
* Primitive Type: Numeric
54+
* Keywords: ```output, outputs```
55+
56+
Gets the current energy output, in MW.
57+
58+
```
59+
Print "Energy Output: " + "My Solar Panel" output
60+
```
61+
62+
## "Limit" Property
63+
* Read-only
64+
* Primitive Type: Numeric
65+
* Keywords: ```limit, limits```
66+
67+
Gets the maximum energy output the solar is capable of, in MW.
68+
69+
```
70+
Print "Maximum Output: " + "My Solar Panel" limit
71+
```
72+
73+
## "Ratio" Property
74+
* Read-only
75+
* Primitive Type: Numeric
76+
* Keywords: ```ratio, ratios, percent, percents, percentage, percentages```
77+
78+
Returns a value between 0 - 1 representing the current output over the maximum output.
79+
80+
```
81+
Print "Output Ratio: " + "My Solar Panel" ratio
82+
```

‎docs/EasyCommands/blockHandlers/turbine.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Wind Turbine Block Handler
2+
3+
This Block Handler handles Wind Turbines. It can be used to turn on/off the Wind Turbine and get information about its energy output
4+
5+
* Block Type Keywords: ```turbine```
6+
* Block Type Group Keywords: ```turbines```
7+
8+
Default Primitive Properties:
9+
* Bool - Enabled
10+
11+
## "Enabled" Property
12+
* Primitive Type: Bool
13+
* Keywords: ```enable, enabled```
14+
* Inverse Keywords: ```disable, disabled```
15+
16+
Enables or Disables the given block
17+
18+
```
19+
#Enable Block
20+
enable "My Wind Turbine"
21+
set "My Wind Turbine" to enabled
22+
turn on "My Wind Turbine"
23+
24+
#Disable Block
25+
disable "My Wind Turbine"
26+
set "My Wind Turbine" to disabled
27+
turn off "My Wind Turbine"
28+
```
29+
30+
## "Power" Property
31+
* Primitive Type: Bool
32+
* Keywords: ```power, powered```
33+
34+
Turns on or off power to the block. Effectively the same as the Enabled property.
35+
36+
```
37+
#Turn on
38+
turn on power to "My Wind Turbine"
39+
power on "My Wind Turbine"
40+
41+
#Turn off
42+
turn off "My Wind Turbine"
43+
power off "My Wind Turbine"
44+
```
45+
46+
## "Output" Property
47+
* Read-only
48+
* Primitive Type: Numeric
49+
* Keywords: ```output, outputs```
50+
51+
Gets the current energy output, in MW.
52+
53+
```
54+
Print "Energy Output: " + "My Wind Turbine" output
55+
```
56+
57+
## "Limit" Property
58+
* Read-only
59+
* Primitive Type: Numeric
60+
* Keywords: ```limit, limits```
61+
62+
Gets the maximum energy output the wind turbine is capable of, in MW.
63+
64+
```
65+
Print "Maximum Output: " + "My Wind Turbine" limit
66+
```
67+
68+
## "Ratio" Property
69+
* Read-only
70+
* Primitive Type: Numeric
71+
* Keywords: ```ratio, ratios, percent, percents, percentage, percentages```
72+
73+
Returns a value between 0 - 1 representing the current output over the maximum output.
74+
75+
```
76+
Print "Output Ratio: " + "My Wind Turbine" ratio
77+
```

0 commit comments

Comments
 (0)