Description

This function will load the buffer data that was previously saved using the buffer_save functions into a new buffer. This new buffer is created by the function as a "grow" buffer (see here) with a byte alignment of 1, and the new buffer id is returned. This ID should be stored in a variable and used in all further function calls to this buffer.

NOTE: It's important that you remove any dynamically created resources like this from memory when you no longer need them to prevent memory leaks, so when you are finished with the buffer that you have created you should free it up again using buffer_delete.

Syntax:

buffer_load(filename);

Returns:

real

Example:

player_buffer = buffer_load("Player_Save.sav");

The above code will load a previously saved buffer into memory, creating a new buffer. The index of this new buffer is stored in the variable "player_buffer".