Skip to content

WorldStreamer

Inherits: RefCounted < Object

This class is what you will use for saving and loading the simulations created by a PowderSimulation Node.



NOTE: This class defines an override for _Notification(), so if you are extending this class and using those functions, make sure to include super() or the C# equivalent in it so it still calls the parent class functions as well as whatever you put.

Static Methods

Return Type Method
WorldStreamer Open()
WorldStreamer Create()
string SaveEmpty()
bool IsFileUsable()

Public Methods

Return Type Method
void Close()
bool FlushDeadChunks()
bool SaveWorld()
bool LoadWorld()
void SaveChunk()
void UnloadChunk()
bool LoadChunk(Vector2I ChunkPosition)
Array[Vector2I] GetAvailableChunks()

Static Method Descriptions

WorldStreamer Open(string WorldPath, PowderSimulation Simulation)

  • string WorldPath - The path to the file to open. must point to a file with the .pwdr extension.
  • PowderSimulation Simulation - The simulation node for this WorldStreamer instance to save and load from.

Creates a new WorldStreamer object and assigns it the specified file. WorldPath must point to an existing file with the .pwdr extension.

Returns a new WorldStreamer object if the file is usable; otherwise returns null.


WorldStreamer Create(string WorldDirPath, string FileName, PowderSimulation Simulation)

  • string WorldDirPath - The path to the folder for this file to be saved in. Usually starts with user://. Must end with /
  • string FileName - The name for the new file to be called. The extension is automatically attached, so no need to add .pwdr to the end of this parameter.
  • PowderSimulation Simulation - The simulation node for this WorldStreamer instance to save and load from.

Creates a new WorldStreamer object and a fresh .pwdr file with the given FileName assigned to it. WorldDirPath must point to a directory in which the file can be created.
FileName MUST be different than an already existing file. Otherwise it opens the existing file.

Returns a new WorldStreamer object if the filename and directory path are usable; otherwise returns null.


string SaveEmpty(string Name, string Path)

  • string Name - The name to be given to the newly created file. The file extension is automatically attached, so no need to add .pwdr to the end of this parameter.
  • string Path - The path to the folder for this file to be saved in. Usually starts with user://. Must end with /

Creates an empty save file. Path must point to a directory in which the new file can be added to. Path also must end with /.

Returns the path to the newly created file.


bool IsFileUsable(string Path)

  • string Path - The path to the file to check.

Returns whether the given file correctly contains the key and the correct file extension. Basically whether or not the save is initially valid.


Method Descriptions

void Close()

Flushes dead chunks, closes the file, and disposes of this object.

Note: WorldStreamer will automatically close when it's freed, which happens when it goes out of scope or when it gets assigned with null. In C# the reference must be disposed after we are done using it, this can be done with the using statement or calling the Dispose method directly.


bool FlushDeadChunks()

Reads through the file and removes saved chunks that are duplicates. Uses ChunkFileOffsets to determine duplicates.
Will most likely fix a corrupted file.

Automatically called when Close is called. Should not be called often, as it rewrites the whole file.

Returns whether or not there were any dead chunks to remove.


bool SaveWorld(bool Override)

  • bool Override - Whether or not to override the contents of the file, essentially replacing the contents with the current ones.

Saves the world to disk, only operating on the chunks currently active in the simulation.

Returns whether the operation was successful or not.


bool LoadWorld()

Replaces the current active chunks in the simulation with the corresponding saved chunks in the file. Does not create chunks.

Returns whether or not there were any currently loaded chunks saved in the file.


void SaveChunk(SandInfo.Chunk chunk)

  • SandInfo.Chunk chunk - The chunk to save to file.

Saves the given chunk to the file. Creates a dead chunk in the file if there was an old version already saved. The dead chunk can be removed by calling FlushDeadChunks().


void UnloadChunk(SandInfo.Chunk chunk)

  • SandInfo.Chunk chunk - The chunk to unload.

Saves the given Chunk to the file, and removes it from the simulation. Uses SaveChunk() to save to file, so everything from that description applies here.


bool LoadChunk(Vector2I ChunkPosition)

  • Vector2I ChunkPosition - The position to load a chunk to.

Replaces or adds a chunk to the simulation with corresponding data from the file.

  • Returns whether the specified chunk position exists in the file.


Array[Vector2I] GetAvailableChunks()

Returns a Godot Array containing the positions of all chunks saved in the file.