Signal Functions - Versionsgeschichte

Marc Horstmann: Die Seite wurde neu angelegt: „

EEPSetSi…“
2018-09-07T12:16:53Z

Die Seite wurde neu angelegt: „ <table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;"> <tr> <th colspan="2">EEPSetSi…“

Neue Seite
<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPSetSignal()</th>
<th style="padding: 10px;">EEPSetSignal(ID,Aspect,Callback)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
-- switch signal 0023 to 1 (aspect depends on signal)
EEPSetSignal(23, 1)

-- switch signal 0045 to 1 and call
EEPOnSignal_45()
EEPSetSignal(45, 1, 1)
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">two or three</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Switches a signal</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>First argument is a numeric value representing the signal’s ID.</li>
<li>Second argument is the signal’s aspect.</li>
<li>If a 1 is entered as a third (optional) argument, the EEPOnSignal_x() function for this signal is called when the signal’s aspect has changed.</li>
<li><b>Use with care!</b> The signal must be registerd and the corresponding function must be declared. (see next page). Careless use of this function may result in infinite loops.</li>
<li>The function returns a 1 if the signal and the demanded aspect exist. It returns a 0 if either one of the two could not be found.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPGetSignal()</th>
<th style="padding: 10px;">EEPGetSignal(ID)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
currentAspect = EEPGetSignal(1)
if currentAspect == 0 then
print("Signal 1 doesn’t exist")
elseif currentAspect == 1 then
print("Signal 1 set to Danger")
elseif currentAspect == 2 then
print("Signal 1 set to Clear")
end
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Provides the current state of a signal.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>Argument is the signal’s ID.</li>
<li>Return value is a numeric representation of the signal’s current aspect. The value reflects the aspect’s position in the effects list of the signal’s properties.</li>
<li>The return value is 0 if the signal doesn’t exist.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPRegisterSignal()</th>
<th style="padding: 10px;">EEPRegisterSignal(ID)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
EEPRegisterSignal(1)
function EEPOnSignal_1(newAspect)
print("Signal 1 switched to ", newAspect)
end
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Registers a signal for the callback function EEPOnSignal_x(). The requirement of a registration prevents signals from triggering a callback when no appropriate function was declared.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>The registration is mandatory for those signals which you want to trigger the EEPOnSignal_x() function whenever the aspect changes.</li>
<li>Argument is the signal’s ID.</li>
<li>Return value is 1, if the signal exists or 0 if it doesn’t exist.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPOnSignal_x()</th>
<th style="padding: 10px;">EEPOnSignal_x(Aspect)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
EEPRegisterSignal(1)
function EEPOnSignal_1(newAspect)
print("Signal 1 switched to ", newAspect)
end
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">none</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;"> Every aspect change induced by a contact or by manual operation (directly or in a link chain) triggers this callback function if the signal has been registerd for callbacks.<b>However</b>: Changing this or a linked signal’s state by Lua function will not trigger thecallback, unless the third argument in that function was a 1.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>The name of the function must not end in _x but with the signal’s ID. For signal 0012 the correct name of the function would be EEPOnSignal_12().</li>
<li><b>Please note</b>: The leading zeroes must be omitted in the function’s name!</li>
<li>The function is called with the new signal aspect as an argument. The number matches the position in the signal’s aspect list as found in the signal’s properties. Use a variable of your choosing to store this value.</li>
<li>EEP requires no return value when calling this function.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPGetSignalTrainsCount()</th>
<th style="padding: 10px;">EEPGetSignalTrainsCount(ID)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
EEPGetSignalTrainsCount(3)
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 13.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Returns the number of consists waiting at the specified signal.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>Argument is the signal ID.</li>
<li>Return value ist he number of trains (cars, trams etc.) held by the signal.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPGetSignalTrainName()</th>
<th style="padding: 10px;">EEPGetSignalTrainName(ID,Positionsnr.)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
EEPGetSignalTrainName(3 , 1)
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">two</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 13.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Returns the name oft he specified consist waiting at the specified signal.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>First argument is the signal ID.</li>
<li>Second argument ist the position of the train (car, tram ...) in the queue.</li>
<li>Return value ist the name of the specified consist.</li>
</ul>
</td>
</tr>
</table>