Blitz3D+ Command Reference

SaveWorldDocument ( document[,file$] )

Parameters

document - world document handle

file$ (optional) - Save As destination; required while the document is untitled

Description

Validates and atomically saves a world document.

The complete assets-and-entities document is saved. A successful Save As adopts the new path and clears dirty state.

For the full story, see the Debug World Editor guide.

Requires Extended mode.

See also: CreateWorldDocument, LoadWorldDocument, ValidateWorldDocument, WorldDocumentPath, WorldDocumentDirty.

Example

; SaveWorldDocument Example - Extended mode
document=CreateWorldDocument("save-example","Save Example")
If document=0 Then RuntimeError WorldDocumentError()
If Not SaveWorldDocument(document,"world-document-save-example.world") Then RuntimeError WorldDocumentError()
Print "Saved "+WorldDocumentPath(document)
FreeWorldDocument document
End