|
bank - bank handle returned by CreateBank offset - position in the bank to read from, in bytes (0 = first byte) |
|
Reads a byte from a bank and returns it as a value from 0 to 255. A byte occupies 1 byte of the bank and is always read unsigned: whatever was poked, you get its low 8 bits as 0 to 255. Offsets are range checked - reading outside the bank raises a runtime error rather than returning garbage. See also: PokeByte, PeekShort, PeekInt, PeekFloat. |
; PeekByte Example
; ----------------
; A player save-game record packed into a memory bank.
; Field sizes: byte=1, short=2, int=4, float=4 bytes.
;
; offset 0 flags (byte, 1 byte )
; offset 1 hp (short, 2 bytes)
; offset 3 score (int, 4 bytes)
; offset 7 x_pos (float, 4 bytes) = 11 bytes in total
save=CreateBank(11)
; Pack the record - each Poke writes its field at a byte offset
PokeByte save,0,5
PokeShort save,1,250
PokeInt save,3,1234567
PokeFloat save,7,17.25
; Unpack the record - PeekByte reads the 1-byte flags field
; back from offset 0 (values 0-255)
Print "Player record in a "+BankSize(save)+" byte bank:"
Print ""
Print "offset 0 flags (byte) = "+PeekByte(save,0)
Print "offset 1 hp (short) = "+PeekShort(save,1)
Print "offset 3 score (int) = "+PeekInt(save,3)
Print "offset 7 x_pos (float) = "+PeekFloat(save,7)
; PeekByte can also dump every byte, making the layout visible
; (ints and floats are stored low byte first)
dump$=""
For i=0 To BankSize(save)-1
dump$=dump$+PeekByte(save,i)+" "
Next
Print ""
Print "Raw bytes: "+dump$
; Release the memory when done
FreeBank save
Print ""
Print "Press any key to close the example"
WaitKey
End