Lua:Class:StringStream

<> Lua API Reference

class StringStream : Stream

The StringStream class represents a stream backed by an internal string.

A StringStream inherits from Stream and Object. It can be created with createStringStream and is useful when stream operations should be performed on string data.

Inheritance

Class	Inherits From	Description
StringStream	Stream	A stream object backed by an internal string.
Stream	Object	Base class for stream objects.

Creation

<> Lua API Reference

function createStringStream(string) : StringStream

Creates a StringStream object initialized with the given string.

Function Parameters

Parameter	Type	Description
string	String	The initial string data for the StringStream.

Returns

StringStream — The created StringStream object.

Properties

Property	Type	Description
DataString	String	The internal string stored by the StringStream.

Methods

This class has no documented methods beyond the inherited stream methods.

Examples

local stream = createStringStream("Hello World")

print(stream.DataString)

stream.destroy()

local stream = createStringStream("Initial text")

stream.DataString = "Changed text"

print(stream.DataString)

stream.destroy()

local fileStr = nil
local tableFile = findTableFile('PlayerBaseHook.CEA')
if tableFile ~= nil then
  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)
  fileStr = stringStream.DataString
  stringStream.destroy()
end

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine