Difference between revisions of "Lua:Class:Stream"

From Cheat Engine
Jump to navigation Jump to search
Line 12: Line 12:
 
== Methods ==
 
== Methods ==
  
; copyFrom(stream, count)
+
; copyFrom(''stream'', ''count'')
 
: Copies 'count' number of bytes from the given 'stream' to this stream
 
: Copies 'count' number of bytes from the given 'stream' to this stream
 
: Note: Always set 'Postion' before using 'copyFrom' (i.e.: 0 for start of steam).
 
: Note: Always set 'Postion' before using 'copyFrom' (i.e.: 0 for start of steam).
Line 21: Line 21:
 
  stringStream.copyFrom(tableFile.Stream, tableFile.Stream.Size)
 
  stringStream.copyFrom(tableFile.Stream, tableFile.Stream.Size)
  
; read(count) : table
+
; read(''count'') : table
 
: Returns a byte table containing the bytes of the stream.
 
: Returns a byte table containing the bytes of the stream.
 
: This increases the position.
 
: This increases the position.
  
; write(bytetable, count OPTIONAL)
+
; write(''byteTable'', ''count'' OPTIONAL)
 
: Writes the given bytetable to the stream
 
: Writes the given bytetable to the stream
  

Revision as of 06:45, 11 March 2017

Stream class: (Inheritance: Object)

Base class for byte stream objects.

Properties

Size : integer
The byte size of the stream.
Position : integer
The current byte position of the stream.

Methods

copyFrom(stream, count)
Copies 'count' number of bytes from the given 'stream' to this stream
Note: Always set 'Postion' before using 'copyFrom' (i.e.: 0 for start of steam).
Example:
local stringStream = createStringStream()
stringStream.Position = 0 -- if not set before using 'copyFrom' the 'StringStream' object will be inconsistent.
stringStream.copyFrom(tableFile.Stream, tableFile.Stream.Size)
read(count) : table
Returns a byte table containing the bytes of the stream.
This increases the position.
write(byteTable, count OPTIONAL)
Writes the given bytetable to the stream

See also

Related Functions

Related Classes