LumpRead: Difference between revisions

LumpRead (view source)

196 bytes added , 4 January

Update formatting and specifications on failure

26

edits

@@ Line 6: / Line 6: @@
 By default, the ''type'' returned is an unsigned 8-bit integer.
 ===Parameters===
-*''lump'': The lump index as returned from <code>[[LumpOpen]]</code>.
+*''lump'': The lump index as returned from <tt>[[LumpOpen]]</tt>.
 *''pos'': The byte position in the lump to read from.
 *''type'': The type of integer that should be returned.
-**''LUMP_READ_BYTE'': Signed 8-bit integer.
+**<code>LUMP_READ_BYTE</code>: Signed 8-bit integer.
-**''LUMP_READ_UBYTE'': Unsigned 8-bit integer.
+**<code>LUMP_READ_UBYTE</code>: Unsigned 8-bit integer.
-**''LUMP_READ_SHORT'': Signed 16-bit integer.
+**<code>LUMP_READ_SHORT</code>: Signed 16-bit integer.
-**''LUMP_READ_USHORT'': Unsigned 16-bit integer.
+**<code>LUMP_READ_USHORT</code>: Unsigned 16-bit integer.
-**''LUMP_READ_INT'': Signed 32-bit integer.
+** <code>LUMP_READ_INT</code>: Signed 32-bit integer.
-**''LUMP_READ_FLOAT'': Signed 32-bit float converted to a fixed-point.
+**<code>LUMP_READ_FLOAT</code>: Signed 32-bit float converted to a fixed-point.
-===Return value===
+===Return value ===
 Returns the integer that was read.
-Returns 0 if the ''lump'' passed is invalid, or when the ''type'' passed is invalid.
+Returns 0 if the ''lump'' passed is invalid, or when the ''type'' passed is invalid, alongside a console message.
+Also returns 0 when called on a lump that was not opened with <tt>[[LumpOpen]]</tt>, alongside a console message.
 ==Examples==
 {{noexamples}}