Skip to content

Methods

Creating Component

To create a buffer, you will need to use these methods listed below:

1
2
3
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(size : number?)

This will create a buffer of X bytes.

Warning

If the size is not set, the default value will be 0. You can always use :allocate() to increase the size.

Advanced

There are other ways to create a buffer, for example: with a string or simply with an existing buffer.

1
2
3
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.from(b : buffer)

Note

Note that the buffer data is not lost, the offset is directly set to the buffer size. Please use from only when you know what you are doing.

1
2
3
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.fromString(str : string)

This will use the .from method once the buffer is converted to a buffer.

Warning

Please use this method only if you know what you are doing.

Allocating space

When creating a buffer, you can later increase its size regardless of the method used. Whether you use from or fromString, you can always expand the buffer size with :allocate.

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

myBuffer:allocate(size : number)

Others

Other useful methods are available in the component.

Empty Component

1
2
3
local Buffer = require(somewhere.Buffer)

local emptyBuffer = Buffer.Empty() -- or Buffer.empty()

This will create an empty Buffer

Compress

1
2
3
4
local my_buffer = Buffer.create(1000)

local compressed_buffer = my_buffer:Compress(Enum.CompressionAlgorithm.Zstd)
print(compressed_buffer) --> buffer

Return a compressed buffer with the target Compression Algorithm

Info

  • This function use EncodingService:CompressBuffer(). Please see the Roblox API for more infos

Warning

  • Do not use this for buffers smaller than 30 bytes or in the 30–50 bytes range.

Decompress (Constructor)

1
2
3
4
5
6
local my_buffer = Buffer.create(1000)

local compressed_buffer = my_buffer:Compress(Enum.CompressionAlgorithm.Zstd)
local decompressed_buffer = Buffer.Decompress(compressed_buffer,Enum.CompressionAlgorithm.Zstd)

print(decompressed_buffer)

Return the decompressed buffer as an BufferComponentClass with the target Compression Algorithm.

The buffer must be already compressed with the target Compression Algorithm.

Info

  • This function use EncodingService:DecompressBuffer(). Please see the Roblox API for more infos

Warning

  • Make sure you use the exact same Compression Algorithm as the compressed buffer.

OnOffsetChanged

1
2
3
4
5
6
7
local my_buffer = Buffer.create(10)

my_buffer:OnOffsetChanged(function(oldOffset, newOffset)
    print(oldOffset,newOffset)
end)

my_buffer:writei8(127)

Connects a callback to the OffsetChanged signal. The callback is called when the offset is changed.

Return : SignalConnection

OnInstanceOffsetChanged

1
2
3
4
5
6
7
local my_buffer = Buffer.create(10)

my_buffer:OnInstanceOffsetChanged(function(oldOffset, newOffset)
    print(oldOffset,newOffset)
end)

my_buffer:WriteInstance(workspace.Baseplate)

Connects a callback to the InstanceOffsetChanged signal. The callback is called when the instance offset is changed.

Return : SignalConnection

OnCapacityChanged

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
local my_buffer = Buffer.create(10)

local connection = my_buffer:OnCapacityChanged(function(oldSize, newSize)
    print(oldSize,newSize)
end)

my_buffer += 5
my_buffer:allocate(5)
my_buffer *= 5

--later

connection:Disconnect()

Connects a callback to the CapacityChanged signal. The callback is called when the capacity is changed.

Info

  • __mult can fire CapacityChanged same for __add
  • :allocate can fire CapacityChanged

Return : SignalConnection

GetRemainingSpace

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(4)

print(myBuffer:GetRemainingSpace()) --> 4 cause we didn't write anything yet

return the actual remaining space of the current buffer

GetOffset

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

print(myBuffer:GetOffset())

return the actual offset of the buffer

GetInstanceOffset

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

print(myBuffer:GetInstanceOffset())

return the actual instance offset of the buffer

GetBuffer

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

print(myBuffer:GetBuffer())

return the current buffer

GetInstanceBuffer

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

print(myBuffer:GetInstanceBuffer())

return the current instance buffer

GetBufferSize

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

print(myBuffer:GetBufferSize())

return the actual buffer size (not the written data size)

Copy

1
2
3
4
5
6
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

local copy_myBuffer = myBuffer:Copy()
print(buff == copy_myBuffer) --> false

Create and return a copy of the current BufferComponent

Clear

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

myBuffer:Clear()

clear the instance_buffer and the buffer itself

both offset will be set to 0.

Note

this return self allow you to chain method

ClearInstances

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

myBuffer:ClearInstances()

Clear the instance_buffer.

instance_offset will be set to 0.

Note

this return self allow you to chain method

ClearBuffer

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

myBuffer:ClearBuffer()

Clear the buffer.

The buffer offset will be set to 0.

Note

this return self allow you to chain method

EnableAutoAllocate

1
my_buffer:EnableAutoAllocate()

Ignore All allocation errors and performs auto allocation when needed

DisableAutoAllocate

1
my_buffer:DisableAutoAllocate()

Enabled back All allocation errors and does no longer performs auto allocation when needed

DisconnectAllSignals

1
my_buffer:DisconnectAllSignals()

Disconnect all signals OnOffsetChanged,OnInstanceOffset,OnCapacityChanged

Destroy

1
2
3
4
5
local Buffer = require(somewhere.Buffer)

local myBuffer = Buffer.create(0)

myBuffer:Destroy()

Destroy the actual BufferComponent. You can't use the BufferComponent after this.

Alias

Alias for the constructor and the component

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
--Constructor alias
BufferConstructor.new = BufferConstructor.create
BufferConstructor.New = BufferConstructor.create

BufferConstructor.Empty = function() : BufferComponentClass
    return BufferConstructor.create(0)
end
BufferConstructor.empty = BufferConstructor.Empty

BufferConstructor.From = BufferConstructor.from
BufferConstructor.FromString = BufferConstructor.fromString
BufferConstructor.Tostring = BufferConstructor.tostring

BufferConstructor.serialize = BufferConstructor.Serialize
BufferConstructor.deserialize = BufferConstructor.Deserialize

BufferConstructor.deserializeAll = BufferConstructor.DeserializeAll
BufferConstructor.serializeAll = BufferConstructor.SerializeAll

BufferConstructor.decompress = BufferConstructor.Decompress

BufferConstructor.serializeCompressed = BufferConstructor.SerializeCompressed
BufferConstructor.deserializeCompressed = BufferConstructor.DeserializeCompressed

BufferConstructor.serializeAllCompressed = BufferConstructor.SerializeAllCompressed
BufferConstructor.deserializeAllCompressed = BufferConstructor.DeserializeAllCompressed

--Component alias
BufferComponent.Allocate = BufferComponent.allocate

--[Writer] signed interger alias
BufferComponent.writeI1 = BufferComponent.WriteI1
BufferComponent.writei1 = BufferComponent.WriteI1

BufferComponent.writeI8 = BufferComponent.WriteI8
BufferComponent.writei8 = BufferComponent.WriteI8

BufferComponent.writeI16 = BufferComponent.WriteI16
BufferComponent.writei16 = BufferComponent.WriteI16

BufferComponent.writeI24 = BufferComponent.WriteI24
BufferComponent.writei24 = BufferComponent.WriteI24

BufferComponent.writeI32 = BufferComponent.WriteI32
BufferComponent.writei32 = BufferComponent.WriteI32

BufferComponent.writeI40 = BufferComponent.WriteI40
BufferComponent.writei40 = BufferComponent.WriteI40

BufferComponent.writeI48 = BufferComponent.WriteI48
BufferComponent.writei48 = BufferComponent.WriteI48

BufferComponent.writeI54 = BufferComponent.WriteI54
BufferComponent.writei54 = BufferComponent.WriteI54

--[Writer] unsigned interger alias
BufferComponent.writeU1 = BufferComponent.WriteU1
BufferComponent.writeu1 = BufferComponent.WriteU1

BufferComponent.writeU8 = BufferComponent.WriteU8
BufferComponent.writeu8 = BufferComponent.WriteU8

BufferComponent.writeU16 = BufferComponent.WriteU16
BufferComponent.writeu16 = BufferComponent.WriteU16

BufferComponent.writeU24 = BufferComponent.WriteU24
BufferComponent.writeu24 = BufferComponent.WriteU24

BufferComponent.writeU32 = BufferComponent.WriteU32
BufferComponent.writeu32 = BufferComponent.WriteU32

BufferComponent.writeU40 = BufferComponent.WriteU40
BufferComponent.writeu40 = BufferComponent.WriteU40

BufferComponent.writeU48 = BufferComponent.WriteU48
BufferComponent.writeu48 = BufferComponent.WriteU48

BufferComponent.writeU54 = BufferComponent.WriteU54
BufferComponent.writeu54 = BufferComponent.WriteU54

--[Writer] float interger alias
BufferComponent.writeF16 = BufferComponent.WriteF16
BufferComponent.writef16 = BufferComponent.WriteF16

BufferComponent.writeF32 = BufferComponent.WriteF32
BufferComponent.writef32 = BufferComponent.WriteF32

BufferComponent.writeF64 = BufferComponent.WriteF64
BufferComponent.writef64 = BufferComponent.WriteF64

--[Writer] string alias
BufferComponent.writeString8 = BufferComponent.WriteString8
BufferComponent.writestring8 = BufferComponent.WriteString8

BufferComponent.writeString16 = BufferComponent.WriteString16
BufferComponent.writestring16 = BufferComponent.WriteString16

BufferComponent.writeString32 = BufferComponent.WriteString32
BufferComponent.writestring32 = BufferComponent.WriteString32

BufferComponent.writeString64 = BufferComponent.WriteString64
BufferComponent.writestring64 = BufferComponent.WriteString64

BufferComponent.writeString = BufferComponent.WriteString
BufferComponent.writestring = BufferComponent.WriteString

--[Writer] boolean alias
BufferComponent.writeBool1 = BufferComponent.WriteBool1
BufferComponent.writebool1 = BufferComponent.WriteBool1

BufferComponent.writeBool8 = BufferComponent.WriteBool8
BufferComponent.writebool8 = BufferComponent.WriteBool8


--[Writer] instance alias
BufferComponent.writeInstance = BufferComponent.WriteInstance
BufferComponent.writeinstance = BufferComponent.WriteInstance

--[Writer] roblox type alias
BufferComponent.writeVector2 = BufferComponent.WriteVector2
BufferComponent.writevector2 = BufferComponent.WriteVector2

BufferComponent.writeVector2int16 = BufferComponent.WriteVector2Int16
BufferComponent.writevector2int16 = BufferComponent.WriteVector2Int16

BufferComponent.writeVector3 = BufferComponent.WriteVector3
BufferComponent.writevector3 = BufferComponent.WriteVector3

BufferComponent.writeVector3int16 = BufferComponent.WriteVector3Int16
BufferComponent.writevector3int16 = BufferComponent.WriteVector3Int16

BufferComponent.writeCFrame = BufferComponent.WriteCFrame
BufferComponent.writecframe = BufferComponent.WriteCFrame

BufferComponent.writeLossyCFrame = BufferComponent.WriteLossyCFrame
BufferComponent.writelossyCFrame = BufferComponent.WriteLossyCFrame

BufferComponent.writeUdim = BufferComponent.WriteUDim
BufferComponent.writeudim = BufferComponent.WriteUDim
BufferComponent.WriteUdim = BufferComponent.WriteUDim

BufferComponent.writeUdim2 = BufferComponent.WriteUDim2
BufferComponent.writeudim2 = BufferComponent.WriteUDim2
BufferComponent.WriteUdim2 = BufferComponent.WriteUDim2

BufferComponent.writeColor3 = BufferComponent.WriteColor3
BufferComponent.writecolor3 = BufferComponent.WriteColor3

BufferComponent.writeRect = BufferComponent.WriteRect
BufferComponent.writerect = BufferComponent.WriteRect

BufferComponent.writeRegion3 = BufferComponent.WriteRegion3
BufferComponent.writeregion3 = BufferComponent.WriteRegion3

BufferComponent.WriteRegion3Int16 = BufferComponent.WriteRegion3int16
BufferComponent.writeRegion3int16 = BufferComponent.WriteRegion3int16
BufferComponent.writeregion3int16 = BufferComponent.WriteRegion3int16

BufferComponent.writeVector = BufferComponent.WriteVector
BufferComponent.writevector = BufferComponent.WriteVector

BufferComponent.writeEnum = BufferComponent.WriteEnum
BufferComponent.writeenum = BufferComponent.WriteEnum

BufferComponent.writeRotationCurveKey = BufferComponent.WriteRotationCurveKey

BufferComponent.writeFloatCurveKey = BufferComponent.WriteFloatCurveKey

BufferComponent.writeColorSequence = BufferComponent.WriteColorSequence

BufferComponent.writeNumberRange = BufferComponent.WriteNumberRange

BufferComponent.writeNumberSequence = BufferComponent.WriteNumberSequence

--[Custom Writer] alias
BufferComponent.writeAs = BufferComponent.WriteAs

BufferComponent.writeArray = BufferComponent.WriteArray
BufferComponent.writearray = BufferComponent.WriteArray

--[Reader] signed interger alias
BufferComponent.readI1 = BufferComponent.ReadI1
BufferComponent.readi1 = BufferComponent.ReadI1

BufferComponent.readI8 = BufferComponent.ReadI8
BufferComponent.readi8 = BufferComponent.ReadI8

BufferComponent.readI16 = BufferComponent.ReadI16
BufferComponent.readi16 = BufferComponent.ReadI16

BufferComponent.readI24 = BufferComponent.ReadI24
BufferComponent.readi24 = BufferComponent.ReadI24

BufferComponent.readI32 = BufferComponent.ReadI32
BufferComponent.readi32 = BufferComponent.ReadI32

BufferComponent.readI40 = BufferComponent.ReadI40
BufferComponent.readi40 = BufferComponent.ReadI40

BufferComponent.readI48 = BufferComponent.ReadI48
BufferComponent.readi48 = BufferComponent.ReadI48

BufferComponent.readI54 = BufferComponent.ReadI54
BufferComponent.readi54 = BufferComponent.ReadI54

--[Reader] unsigned interger alias
BufferComponent.readU1 = BufferComponent.ReadU1
BufferComponent.readu1 = BufferComponent.ReadU1

BufferComponent.readU8 = BufferComponent.ReadU8
BufferComponent.readu8 = BufferComponent.ReadU8

BufferComponent.readU16 = BufferComponent.ReadU16
BufferComponent.readu16 = BufferComponent.ReadU16

BufferComponent.readU24 = BufferComponent.ReadU24
BufferComponent.readu24 = BufferComponent.ReadU24

BufferComponent.readU32 = BufferComponent.ReadU32
BufferComponent.readu32 = BufferComponent.ReadU32

BufferComponent.readU40 = BufferComponent.ReadU40
BufferComponent.readu40 = BufferComponent.ReadU40

BufferComponent.readU48 = BufferComponent.ReadU48
BufferComponent.readu48 = BufferComponent.ReadU48

BufferComponent.readU54 = BufferComponent.ReadU54
BufferComponent.readu54 = BufferComponent.ReadU54

--[Reader] float interger alias
BufferComponent.readF16 = BufferComponent.ReadF16
BufferComponent.readf16 = BufferComponent.ReadF16

BufferComponent.readF32 = BufferComponent.ReadF32
BufferComponent.readf32 = BufferComponent.ReadF32

BufferComponent.readF64 = BufferComponent.ReadF64
BufferComponent.readf64 = BufferComponent.ReadF64

--[Reader] boolean alias
BufferComponent.readBool1 = BufferComponent.ReadBool1
BufferComponent.readbool1 = BufferComponent.ReadBool1

BufferComponent.readBool8 = BufferComponent.ReadBool8
BufferComponent.readbool8 = BufferComponent.ReadBool8


--[Reader] string alias
BufferComponent.readString = BufferComponent.ReadString
BufferComponent.readstring = BufferComponent.ReadString

--[Reader] instance alias
BufferComponent.readInstance = BufferComponent.ReadInstance
BufferComponent.readinstance = BufferComponent.ReadInstance

--[Reader] roblox type alias
BufferComponent.readVector2 = BufferComponent.ReadVector2
BufferComponent.readvector2 = BufferComponent.ReadVector2

BufferComponent.ReadVector2Int16 = BufferComponent.ReadVector2int16
BufferComponent.readVector2int16 = BufferComponent.ReadVector2int16
BufferComponent.readvector2int16 = BufferComponent.ReadVector2int16

BufferComponent.readVector3 = BufferComponent.ReadVector3
BufferComponent.readvector3 = BufferComponent.ReadVector3

BufferComponent.readVector3int16 = BufferComponent.ReadVector3int16
BufferComponent.readvector3int16 = BufferComponent.ReadVector3int16
BufferComponent.ReadVector3Int16 = BufferComponent.ReadVector3int16

BufferComponent.readCFrame = BufferComponent.ReadCFrame
BufferComponent.readcframe = BufferComponent.ReadCFrame

BufferComponent.readLossyCFrame = BufferComponent.ReadLossyCFrame
BufferComponent.readlossyCFrame = BufferComponent.ReadLossyCFrame

BufferComponent.readUdim = BufferComponent.ReadUDim
BufferComponent.readudim = BufferComponent.ReadUDim
BufferComponent.ReadUdim = BufferComponent.ReadUDim

BufferComponent.readUdim2 = BufferComponent.ReadUDim2
BufferComponent.readudim2 = BufferComponent.ReadUDim2
BufferComponent.ReadUdim2 = BufferComponent.ReadUDim2

BufferComponent.readColor3 = BufferComponent.ReadColor3
BufferComponent.readcolor3 = BufferComponent.ReadColor3

BufferComponent.readRect = BufferComponent.ReadRect
BufferComponent.readrect = BufferComponent.ReadRect

BufferComponent.readRegion3 = BufferComponent.ReadRegion3
BufferComponent.readregion3 = BufferComponent.ReadRegion3

BufferComponent.ReadRegion3Int16 = BufferComponent.ReadRegion3int16
BufferComponent.readRegion3int16 = BufferComponent.ReadRegion3int16
BufferComponent.readregion3int16 = BufferComponent.ReadRegion3int16

BufferComponent.readVector = BufferComponent.ReadVector
BufferComponent.readvector = BufferComponent.ReadVector

BufferComponent.readEnum = BufferComponent.ReadEnum
BufferComponent.readenum = BufferComponent.ReadEnum

BufferComponent.readRotationCurveKey = BufferComponent.ReadRotationCurveKey

BufferComponent.readFloatCurveKey = BufferComponent.ReadFloatCurveKey

BufferComponent.readColorSequence = BufferComponent.ReadColorSequence

BufferComponent.readNumberRange = BufferComponent.ReadNumberRange

BufferComponent.readNumberSequence = BufferComponent.ReadNumberSequence

--[Custom Read] alias
BufferComponent.readAs = BufferComponent.ReadAs

BufferComponent.readArray = BufferComponent.ReadArray
BufferComponent.readarray = BufferComponent.ReadArray

--[Signals] alias
BufferComponent.onOffsetChanged = BufferComponent.OnOffsetChanged
BufferComponent.onCapacityChanged = BufferComponent.OnCapacityChanged
BufferComponent.onInstanceOffsetChanged = BufferComponent.OnInstanceOffsetChanged
BufferComponent.disconnectAllSignals = BufferComponent.DisconnectAllSignals

--[Cursor] alias
BufferComponent.getOffset = BufferComponent.GetOffset
BufferComponent.getoffset = BufferComponent.GetOffset

BufferComponent.getInstanceOffset = BufferComponent.GetInstanceOffset
BufferComponent.getinstanceoffset = BufferComponent.GetInstanceOffset

BufferComponent.getRemainingSpace = BufferComponent.GetRemainingSpace

--[Buffer] alias
BufferComponent.compress = BufferComponent.Compress

BufferComponent.getBuffer = BufferComponent.GetBuffer
BufferComponent.getbuffer = BufferComponent.GetBuffer

BufferComponent.getInstanceBuffer = BufferComponent.GetInstanceBuffer
BufferComponent.getinstancebuffer = BufferComponent.GetInstanceBuffer

BufferComponent.getBufferSize = BufferComponent.GetBufferSize
BufferComponent.getbuffersize = BufferComponent.GetBufferSize

BufferComponent.Copy = BufferComponent.copy

--[Lifecycle] alias
BufferComponent.Clear = BufferComponent.clear

BufferComponent.ClearInstances = BufferComponent.clearInstances

BufferComponent.ClearBuffer = BufferComponent.clearBuffer

BufferComponent.Destroy = BufferComponent.Destroy