ComputerCraft Wiki - User contributions [en]

User:Minozake

2012-05-12T20:03:57Z

Minozake: /* Termination catch for infinite loop daemons */

== Miscellaneous thingies ==

So, I'm using this to post miscellaneous code snippets for other people to use until I find a wiki page for it.

= Termination catch for infinite loop daemons =

So, let's say you want the source of a program in the form of

<pre>
while true do
shell.run("prog", "arg1")
end
</pre>

It's all fine and good, except for a huge potential problem. If you want to terminate it, you will just restart the program being run in the loop. For computers with the program in their startup, it will require the computer be removed and replaced, and that will destroy the contents saved onto its disk. That's where more complex code comes in handy. The code follows the form:

<pre>
function doPullEvent ()
os.pullEventRaw("Terminate")
print("Terminate caught. Exiting.")
end

function doRunProg ()
while true do
shell.run("gps", "host")
end
end

parallel.waitForAny(doPullEvent, doRunProg)
</pre>

It works by parallelizing both functions and waiting for one of them to exit. When one function exits, the program exits. Since it is impossible for the loop to exit, it rests on catching the terminate event, which is already blocking until the event is caught. You could also easily modify this to take a keypress event instead if that is what you prefer, but that will be an exercise left up to the reader.

An example for use would be a GPS daemon. Unfortunately, a GPS host computer at startup that just has `shell.run("gps", "host")` is prone to failures due to timing problems or thunderstorms since they depend on at least 4 other computers to get up and running properly, and it will also be a problem for entire networks that base their hosting off of 4 main computers. A workaround is to hardcode all of the computers, but that requires manual or more complex auto setups. Running `shell.run("gps", "host")` in a startup infinite loop is a fix, but it also blocks all other operation of the computer, especially if trying to debug. Adding the termination catch so that the script is safe to run on startup is recommended and optimal.

I will leave it as an exercise to the reader to figure out how to make this into a flexible script and make it loadable as an API.

User:Minozake

2012-05-12T20:03:02Z

Minozake: /* Termination catch for infinite loop daemons */

== Miscellaneous thingies ==

So, I'm using this to post miscellaneous code snippets for other people to use until I find a wiki page for it.

= Termination catch for infinite loop daemons =

So, let's say you want the source of a program in the form of

<pre>
while true do
shell.run("prog", "arg1")
end
</pre>

It's all fine and good, except for a huge potential problem. If you want to terminate it, you will just restart the program being run in the loop. For computers with the program in their startup, it will require the computer be removed and replaced, and that will destroy the contents saved onto its disk. That's where more complex code comes in handy. The code follows the form:

<pre>
function doPullEvent ()
os.pullEventRaw("Terminate")
print("Terminate caught. Exiting.")
end

function doRunProg ()
while true do
shell.run("gps", "host")
end
end

parallel.waitForAny(doPullEvent, doRunProg)
</pre>

It works by parallelizing both functions and waiting for one of them to exit. When one exits, the program exits. Since it is impossible for the loop to exit, it rests on catching the terminate event. You could also easily modify this to take a keypress event instead if that is what you prefer, but that will be an exercise left up to the reader.

An example for use would be a GPS daemon. Unfortunately, a GPS host computer at startup that just has `shell.run("gps", "host")` is prone to failures due to timing problems or thunderstorms since they depend on at least 4 other computers to get up and running properly, and it will also be a problem for entire networks that base their hosting off of 4 main computers. A workaround is to hardcode all of the computers, but that requires manual or more complex auto setups. Running `shell.run("gps", "host")` in a startup infinite loop is a fix, but it also blocks all other operation of the computer, especially if trying to debug. Adding the termination catch so that the script is safe to run on startup is recommended and optimal.

I will leave it as an exercise to the reader to figure out how to make this into a flexible script and make it loadable as an API.

User:Minozake

2012-05-12T19:30:12Z

Minozake: Added safe terminate code

== Miscellaneous thingies ==

So, I'm using this to post miscellaneous code snippets for other people to use until I find a wiki page for it.

= Termination catch for infinite loop daemons =

So, let's say you want the source of a program in the form of

<pre>
while true do
shell.run("prog", "arg1")
end
</pre>

It's all fine and good, except for a huge potential problem. If you want to terminate it, you will just restart the program being run in the loop. For computers with the program in their startup, it will require the computer be removed and replaced, and that will destroy the contents saved onto its disk. That's where more complex code comes in handy. The code follows the form:

<pre>
function doPullEvent ()
os.pullEventRaw("Terminate")
print("Terminate caught. Exiting.")
end

function doRunProg ()
while true do
shell.run("gps", "host")
end
end

parallel.waitForAny(doPullEvent, doRunProg)
</pre>

An example for use would be a GPS daemon. Unfortunately, a GPS host computer at startup that just has `shell.run("gps", "host")` is prone to failures due to timing problems or thunderstorms since they depend on at least 4 other computers to get up and running properly, and it will also be a problem for entire networks that base their hosting off of 4 main computers. A workaround is to hardcode all of the computers, but that requires manual or more complex auto setups. Running `shell.run("gps", "host")` in a startup infinite loop is a fix, but it also blocks all other operation of the computer, especially if trying to debug. Adding the termination catch so that the script is safe to run on startup is recommended and optimal.

I will leave it as an exercise to the reader to figure out how to make this into a flexible script and make it loadable as an API.

Vector (API)

2012-05-12T18:51:18Z

Minozake: Added link to an introduction to vectors as used in the mod.

The vector API provides methods to create and manipulate vectors. An introduction to vectors can be found on [http://en.wikipedia.org/wiki/Euclidean_vector Wikipedia].

{| border="1" cellpadding="2" cellspacing="0"
!colspan="2" style="text-align: center; background: #DDDDDD"|Static methods
|-
|style="text-align: center; background: #EFEFEF" width="200px"|Method name
|style="text-align: center; background: #EFEFEF" width="*"|Description
|-
|vector.new(x, y, z)
|Creates a vector.<br />
''@param'' '''x, y, z''' the vector coordinates<br />
''@return'' the created vector
|}

{| border="1" cellpadding="2" cellspacing="0"
!colspan="2" style="text-align: center; background: #DDDDDD"|Object methods
|-
|style="text-align: center; background: #EFEFEF" width="200px"|Method name
|style="text-align: center; background: #EFEFEF" width="*"|Description
|-
|vectorA:add(vectorB)
|Adds vectorB to vectorA and returns the resulted vector.
|-
|vectorA:sub(vectorB)
|Subtracts vectorB to vectorA and returns the resulted vector.
|-
|vectorA:mul(vectorB)
|Multiplies vectorB with vectorA and returns the resulted vector.
|-
|vectorA:dot(vectorB)
|Returns the dot product of vectorA and vectorB.
|-
|vectorA:cross(vectorB)
|Returns the vector which resulted in the cross product of vectorA and vectorB.
|-
|vectorA:length()
|Returns the vector's length.
|-
|vectorA:normalize()
|Normalizes the vector and returns the result as a new vector.
|-
|vectorA:round()
|Rounds the vector coordinates to the nearest integers and returns the result as a new vector.
|-
|vectorA:tostring()
|Returns a string representation of the vector in the form of "x,y,z".
|}

[[Category:APIs]]