diff options
Diffstat (limited to 'assets/manual/tex')
-rw-r--r-- | assets/manual/tex/main.tex | 3 | ||||
-rw-r--r-- | assets/manual/tex/nodedef.tex | 27 | ||||
-rw-r--r-- | assets/manual/tex/tables.tex | 27 |
3 files changed, 0 insertions, 57 deletions
diff --git a/assets/manual/tex/main.tex b/assets/manual/tex/main.tex index 593c749..cea1cde 100644 --- a/assets/manual/tex/main.tex +++ b/assets/manual/tex/main.tex @@ -7,9 +7,6 @@ \include{signals.tex} \include{luaatc.tex} -\include{nodedef.tex} -\include{tables.tex} - \include{contributing.tex} \include{manpages.tex} diff --git a/assets/manual/tex/nodedef.tex b/assets/manual/tex/nodedef.tex deleted file mode 100644 index 04a409e..0000000 --- a/assets/manual/tex/nodedef.tex +++ /dev/null @@ -1,27 +0,0 @@ -\section{Node definition} - -\subsection{Node groups} -\advtrains{} uses node groups to identify whether a node has certain properties. The following fields are used: -\begin{apidoc}{Node definition!\texttt{groups}} -\item \apifield{advtrains\_signal} Whether the node is a signal. -\item \apifield{not\_blocking\_trains} The numeric constant 1 if the item does not block trains. -\item \apifield{save\_in\_at\_nodedb} The numeric constant 1 if the item should be save in the internal node database used by \advtrains{}. -\end{apidoc} - -The following values (as numeric constants) are accepted for items in the \texttt{advtrains\_signal} group: -\begin{apidoc}{Node definition!\texttt{groups}!\texttt{advtrains\_signal}} -\item \apienum{1} The node is a signal with a static signal aspect. -\item \apienum{2} The node is a signal, and its signal aspect can be set. -\end{apidoc} - -\subsection{The \texttt{advtrains} field} -The \texttt{advtrains} field in the node definition may contain the following fields: -\begin{apidoc}{Node definition!\texttt{advtrains}} -\item \apifield{get\_aspect(\var{pos}, \var{node})} A function that returns the signal aspect of the signal \var{node} at \var{pos}. The returned signal aspect does not need to be identical to the signal aspect passed to the previous call to \texttt{set\_aspect}. -\item \apifield{set\_aspect(\var{pos}, \var{node}, \var{asp})} A function that sets the aspect of the signal \var{node} at \var{pos} to \var{pos}. If \var{asp} is not supported by the signal, the implementation may choose to set the aspect to something different. -\item \apifield{supported\_aspects} A table of supported signal aspects. -\end{apidoc} - -%%% Local Variables: -%%% TeX-master: "a4manual" -%%% End:
\ No newline at end of file diff --git a/assets/manual/tex/tables.tex b/assets/manual/tex/tables.tex deleted file mode 100644 index 91422b6..0000000 --- a/assets/manual/tex/tables.tex +++ /dev/null @@ -1,27 +0,0 @@ -\section{Table structures}\label{s:structs} - -This section only documents table structures shared among multiple modules. API-specific table structures are documented in the corresponding sections. - -\subsection{Signal aspect table}\label{s:sigasp} -Signal aspect tables may contain the following members: -\begin{apidoc}{Signal aspect table} -\item \apifield{main} The aspect of the main signal. -\item \apifield{type} The type of signal. Please refer to section \ref{s:srtypes} for more information. -\item \apifield{dst} The aspect of the next main signal. -\item \apifield{shunt} Whether shunting is allowed. -\item \apifield{proceed\_as\_main} When shunting is not allowed, whether to let the train continue with shunt mode disabled. -\end{apidoc} - -The \texttt{main} and \texttt{dst} fields may contain one of the following: -\begin{itemize} -\item $n \geq 0$, which changes the speed limit of the corresponding type to $n$, or (for distant signals) indicates the speed limit for the upcoming main signal. -\item $-1$, which lifts the speed limit of the corresponding type, or (for distant signals) indicates that the speed limit is lifted at the upcoming main signal. -\item \luanil, which keeps the speed limit unchanged. -\end{itemize} - -\subsection{Train speed restriction table} -The speed restriction table for trains includes the speed limits for a train, where the key is the type of speed limit and the value is the speed limit itself. - -%%% Local Variables: -%%% TeX-master: "a4manual" -%%% End:
\ No newline at end of file |