====== API Functions ======
This page is currently being updated to the latest version (Zeolite v16.01). Some links may be broken, or refer to the previous API version. I apologise for this inconvenience.
===== Error / logging functions ====
* [[zeolite:functions:zeoReportError]]
* [[zeolite:functions:zeoWriteToLog]]
===== Variable functions =====
* [[zeolite:functions:zvar_Create]]
* [[zeolite:functions:zvar_CreateShared]]
* [[zeolite:functions:zvar_GetSharedVar]]
* [[zeolite:functions:zvar_Delete]]
* [[zeolite:functions:zvar_ReInit]]
* [[zeolite:functions:zvar_Rename]]
* [[zeolite:functions:zvar_GetName]]
* [[zeolite:functions:zvar_GetTypeID]]
* [[zeolite:functions:zvar_IsType]]
* [[zeolite:functions:zvar_GetValue]]
* [[zeolite:functions:zvar_SetValue]]
* [[zeolite:functions:zvar_GetValueEx]]
* [[zeolite:functions:zvar_SetValueEx]]
* [[zeolite:functions:zvar_GetValueText]]
* [[zeolite:functions:zvar_SetValueText]]
* [[zeolite:functions:zvar_Cast]]
* [[zeolite:functions:zvar_CopyValue]]
* [[zeolite:functions:zvar_SetVarRef]]
* [[zeolite:functions:zvar_EditUI]]
* [[zeolite:functions:zvar_GetDataPtr]]
===== Variable type functions =====
* [[zeolite:functions:ztype_GetID]]
* [[zeolite:functions:ztype_GetName]]
===== String functions =====
* [[zeolite:functions:zstr_SetText]]
* [[zeolite:functions:zstr_GetText]]
===== List functions =====
* [[zeolite:functions:zlist_nItems]]
* [[zeolite:functions:zlist_CreateItem]]
* [[zeolite:functions:zlist_GetItemI]]
* [[zeolite:functions:zlist_GetItemA]]
* [[zeolite:functions:zlist_DelItemI]]
* [[zeolite:functions:zlist_DelItemA]]
* [[zeolite:functions:zlist_DelAll]]
* [[zeolite:functions:zlist_SortI]]
* [[zeolite:functions:zlist_SortA]]
* [[zeolite:functions:zlist_Append]]
===== Map functions =====
==== Map initialisation ====
* [[zeolite:functions:zmap_Init]]
* [[zeolite:functions:zmap_Init2]]
* [[zeolite:functions:zmap_InitMosaic]]
* [[zeolite:functions:zmap_Free]]
* [[zeolite:functions:zmap_GetAllocMode]]
==== Map size and scaling ====
* [[zeolite:functions:zmap_GetWidth]]
* [[zeolite:functions:zmap_GetHeight]]
* [[zeolite:functions:zmap_GetHorizScale]]
* [[zeolite:functions:zmap_SetHorizScale]]
* [[zeolite:functions:zmap_GetTileSize]]
* [[zeolite:functions:zmap_GetTileCountX]]
* [[zeolite:functions:zmap_GetTileCountY]]
* [[zeolite:functions:zmap_GetMinMaxAlt]]
* [[zeolite:functions:zmap_SetMinMaxAlt]]
==== Pixel access ====
* [[zeolite:functions:zmap_GetPixel]]
* [[zeolite:functions:zmap_SetPixel]]
* [[zeolite:functions:zmap_LinInterp]]
==== Settings and flags ====
* [[zeolite:functions:zmap_GetMapType]]
* [[zeolite:functions:zmap_GetPixelSize]]
* [[zeolite:functions:zmap_GetWrapFlag]]
* [[zeolite:functions:zmap_SetWrapFlag]]
* [[zeolite:functions:zmap_GetBusyFlag]]
* [[zeolite:functions:zmap_SetBusyFlag]]
* [[zeolite:functions:zmap_GetMosaicFlag]]
* [[zeolite:functions:zmap_GetFlag]]
* [[zeolite:functions:zmap_SetFlag]]
* [[zeolite:functions:zmap_GetSettingsList]]
* [[zeolite:functions:zmap_GetNameInProject]]
==== File input and output ====
* [[zeolite:functions:zmap_SaveFile]]
* [[zeolite:functions:zmap_LoadFile]]
* [[zeolite:functions:zmap_LoadMosaic]]
* [[zeolite:functions:zmap_SaveMosaic]]
* [[zeolite:functions:zmap_SaveMosaicAs]]
* [[zeolite:functions:zmap_ExportMap]]
* [[zeolite:functions:zmap_ExportMosaic]]
* [[zeolite:functions:zmap_GetFilename]]
* [[zeolite:functions:zmap_GetFormat]]
* [[zeolite:functions:zmap_SetFormat]]
==== Mipmaps ====
* [[zeolite:functions:zmap_nMipmaps]]
* [[zeolite:functions:zmap_AllocMipmaps]]
* [[zeolite:functions:zmap_GenMipmaps]]
* [[zeolite:functions:zmap_ClearMipmaps]]
* [[zeolite:functions:zmap_GetMipmapResStep]]
* [[zeolite:functions:zmap_GetMipmapMaxLevel]]
* [[zeolite:functions:zmap_GetMipmapLevel]]
* [[zeolite:functions:zmap_GetMipmapLevel2]]
==== Mosaic functions ====
* [[zeolite:functions:zmap_CombineMosaic]]
* [[zeolite:functions:zmap_SplitToMosaic]]
==== Mosaic tile functions ====
* [[zeolite:functions:zmap_GetMosaicTile]]
* [[zeolite:functions:zmap_tile_GetPixel]]
* [[zeolite:functions:zmap_tile_SetPixel]]
* [[zeolite:functions:zmap_tile_GetMinMaxAlt]]
* [[zeolite:functions:zmap_tile_GetTileCoords]]
* [[zeolite:functions:zmap_tile_SetLock]]
* [[zeolite:functions:zmap_tile_MarkChanged]]
* [[zeolite:functions:zmap_tile_GetDataPtr]]
* [[zeolite:functions:zmap_tile_GetScanlinePtr]]
* [[zeolite:functions:zmap_tile_GetScanlineArray]]
* [[zeolite:functions:zmap_tile_IsContiguous]]
* [[zeolite:functions:zmap_tile_MakeContiguous]]
==== Direct memory access ====
* [[zeolite:functions:zmap_GetDataPtr]]
* [[zeolite:functions:zmap_GetScanlinePtr]]
* [[zeolite:functions:zmap_GetScanlineArray]]
* [[zeolite:functions:zmap_IsContiguous]]
* [[zeolite:functions:zmap_MakeContiguous]]
===== File format functions =====
* [[zeolite:functions:zformat_Create]]
* [[zeolite:functions:zformat_CreateGeneric]]
* [[zeolite:functions:zformat_SetFlags]]
* [[zeolite:functions:zformat_GetFlags]]
* [[zeolite:functions:zformat_SetInfoStr]]
* [[zeolite:functions:zformat_GetExt]]
* [[zeolite:functions:zformat_GetOptionList]]
* [[zeolite:functions:zformat_GetOptionValue]]
* [[zeolite:functions:zformat_SetOptionValue]]
* [[zeolite:functions:zformat_GetFormatByExt]]
* [[zeolite:functions:zformat_GetFormatByExt2]]
* [[zeolite:functions:zformat_GetFormatList]]
* [[zeolite:functions:zformat_GetFormatList2]]
* [[zeolite:functions:zformat_GetActiveFormat]]
* [[zeolite:functions:zformat_GetDefaultFormat]]
===== ZeoFunc functions =====
* [[zeolite:functions:zfunc_Load]]
* [[zeolite:functions:zfunc_GetFunc]]
* [[zeolite:functions:zfunc_GetReturnTypeID]]
* [[zeolite:functions:zfunc_GetArgListPrototype]]
* [[zeolite:functions:zfunc_Execute]]
===== Buffer functions =====
* [[zeolite:functions:zbuffer_Init]]
* [[zeolite:functions:zbuffer_InitByType]]
* [[zeolite:functions:zbuffer_Free]]
* [[zeolite:functions:zbuffer_nItems]]
* [[zeolite:functions:zbuffer_MemSize]]
* [[zeolite:functions:zbuffer_ItemSize]]
* [[zeolite:functions:zbuffer_GetPtr]]
* [[zeolite:functions:zbuffer_GetValue]]
* [[zeolite:functions:zbuffer_SetValue]]
===== Progress box functions =====
* [[zeolite:functions:zprogbox_ShowWnd]]
* [[zeolite:functions:zprogbox_HideWnd]]
* [[zeolite:functions:zprogbox_SetTitle]]
* [[zeolite:functions:zprogbox_SetProgress]]
===== File selector functions =====
* [[zeolite:functions:zfilesel_Init]]
* [[zeolite:functions:zfilesel_GetPathA]]
===== Directory selector functions =====
* [[zeolite:functions:zdirsel_Init]]
* [[zeolite:functions:zdirsel_GetPathA]]
===== Combination selector functions =====
* [[zeolite:functions:zcombosel_Init]]
* [[zeolite:functions:zcombosel_nOptions]]
* [[zeolite:functions:zcombosel_SetOptionsA]]
* [[zeolite:functions:zcombosel_GetOptionsA]]
* [[zeolite:functions:zcombosel_AddOptionA]]
* [[zeolite:functions:zcombosel_FindOptionA]]
* [[zeolite:functions:zcombosel_GetOptionText]]
* [[zeolite:functions:zcombosel_SetCurSelI]]
* [[zeolite:functions:zcombosel_GetCurSelA]]
* [[zeolite:functions:zcombosel_GetCurSelI]]
* [[zeolite:functions:zcombosel_SetCurSelA]]
* [[zeolite:functions:zcombosel_SetSelI]]
* [[zeolite:functions:zcombosel_GetSelA]]
* [[zeolite:functions:zcombosel_GetSelI]]
* [[zeolite:functions:zcombosel_SetSelA]]
* [[zeolite:functions:zcombosel_GetFlags]]
===== Script functions =====
* [[zeolite:functions:zscript_Execute]]
* [[zeolite:functions:zs_Execute]]
===== File / directory functions (zFile.h) =====
* [[zeolite:functions:zfile_GetDir]]
* [[zeolite:functions:zfile_GetExt]]
* [[zeolite:functions:zfile_TrimDir]]
* [[zeolite:functions:zfile_TrimExt]]
* [[zeolite:functions:zfile_FileExists]]
* [[zeolite:functions:zfile_TrimEllipses]]
* [[zeolite:functions:zfile_TrimPath]]
* [[zeolite:functions:zfile_FileExists]]
* [[zeolite:functions:zfile_DirExists]]
* [[zeolite:functions:zfile_CreateDir]]
* [[zeolite:functions:zfile_DeleteDir]]
* [[zeolite:functions:file_IsAbsolutePath]]
* [[zeolite:functions:zfile_FindFile]]
* [[zeolite:functions:zfile_CopyFile]]
===== Menu functions (zMenu.h) =====
* [[zeolite:functions:zmenu_InsertItem]]
===== Project functions (zProj.h) =====
==== Project initialisation ====
* [[zeolite:functions:zproj_IsInit]]
* [[zeolite:functions:zproj_Init]]
* [[zeolite:functions:zproj_Free]]
==== Loading/saving the project ====
* [[zeolite:functions:zproj_LoadProject]]
* [[zeolite:functions:zproj_SaveProject]]
* [[zeolite:functions:zproj_SaveProjectFile]]
* [[zeolite:functions:zproj_SaveProjectAs]]
* [[zeolite:functions:zproj_DemandSave]]
* [[zeolite:functions:zproj_IsPathOK]]
* [[zeolite:functions:zproj_GetProjectFilename]]
==== Map access ====
* [[zeolite:functions:zproj_GetMapList]]
* [[zeolite:functions:zproj_GetMap]]
* [[zeolite:functions:zproj_CreateMap]]
* [[zeolite:functions:zproj_GetOrCreateMap]]
* [[zeolite:functions:zproj_GetHeightfieldRange]]
* [[zeolite:functions:zproj_SetMapFlag]]
* [[zeolite:functions:zproj_GetMapAlternateName]]
==== Loading / saving maps ====
* [[zeolite:functions:zproj_AutoSaveMap]]
* [[zeolite:functions:zproj_AutoLoadMap]]
==== Project settings ====
* [[zeolite:functions:zproj_GetSettingsList]]
* [[zeolite:functions:zproj_GetSetting]]
* [[zeolite:functions:zproj_SetSetting]]
* [[zeolite:functions:zproj_GetOpFlag]]
* [[zeolite:functions:zproj_SetOpFlag]]
* [[zeolite:functions:zproj_DelOpsFollowing]]
==== Scale settings ====
* [[zeolite:functions:zproj_GetCurTileSizeDM]]
* [[zeolite:functions:zproj_SetCurTileSizeDM]]
* [[zeolite:functions:zproj_GetCurHorizScaleHF]]
* [[zeolite:functions:zproj_SetCurHorizScaleHF]]
==== Climates ====
* [[zeolite:functions:zproj_nClimates]]
* [[zeolite:functions:zproj_GetClimate]]
* [[zeolite:functions:zproj_GetClimateA]]
* [[zeolite:functions:zproj_GetClimateIndex]]
* [[zeolite:functions:zproj_AddClimateA]]
===== View functions (zView.h)=====
* [[zeolite:functions:zview_ShowMap]]
* [[zeolite:functions:zview_Refresh]]
* [[zeolite:functions:zview_GetActiveMap]]
* [[zeolite:functions:zview_GetSelectedArea]]
* [[zeolite:functions:zview_SetSelectedArea]]
* [[zeolite:functions:zview_SetMouseMode]]
* [[zeolite:functions:zview_GetBrushRadius]]
* [[zeolite:functions:zview_SetBrushRadius]]
* [[zeolite:functions:zview_EnableDraw]]
===== Application settings functions (helper/zApp.h and helper/zSettings.h) =====
* [[zeolite:functions:zapp_GetTempDir]]
* [[zeolite:functions:zapp_GetUID]]
* [[zeolite:functions:zapp_GetIcon]]
* [[zeolite:functions:zapp_GetPath]]
* [[zeolite:functions:zsettings_GetLocalList]]
* [[zeolite:functions:zsettings_GetPresetsList]]
* [[zeolite:functions:zsettings_SetWndSetting]]
* [[zeolite:functions:zsettings_GetWndSetting]]
===== Undo / backup / restore functions (helper/zBackup.h) =====
* [[zeolite:functions:zbackup_Undo]]
* [[zeolite:functions:zbackup_Restore]]
* [[zeolite:functions:zbackup_nRecords]]
* [[zeolite:functions:zbackup_BackupMaps]]
* [[zeolite:functions:zbackup_BackupMapArea]]
* [[zeolite:functions:zbackup_GetAutoBackupFlag]]
* [[zeolite:functions:zbackup_EditRecord_Init]]
* [[zeolite:functions:zbackup_EditRecord_AddMapArea]]
* [[zeolite:functions:zbackup_EditRecord_Finalise]]
===== XML functions (helper/zXML.h) =====
* [[zeolite:functions:zXML_Save]]
* [[zeolite:functions:zXML_Load]]
===== Calculation manager functions (helper/zCalcMan.h) =====
* [[zeolite:functions:zCalcMan_IsBusy]]
* [[zeolite:functions:zCalcMan_Abort]]
* [[zeolite:functions:zCalcMan_RunCalcScript]]
* [[zeolite:functions:zCalcMan_StartCalcProgress]]
* [[zeolite:functions:zCalcMan_StartCalcProgressGrid]]
* [[zeolite:functions:zCalcMan_AddCalcStage]]
* [[zeolite:functions:zCalcMan_AdvanceCalcStage]]
* [[zeolite:functions:zCalcMan_SetCalcProgress]]
* [[zeolite:functions:zCalcMan_SetCalcTitle]]
* [[zeolite:functions:zCalcMan_HideCalcProgress]]
* [[zeolite:functions:zCalcMan_ProgMapInit]]
* [[zeolite:functions:zCalcMan_ProgMapFree]]