WorldEditorAPI.c

Go to the documentation of this file.

/*
===========================================
Do not modify, this script is generated
===========================================
*/

 
sealed class WorldEditorAPI
{
    private void WorldEditorAPI();
    private void ~WorldEditorAPI();

    proto external bool BeginEntityAction(string historyPointName = string.Empty, string historyPointIcon = string.Empty, void userData = NULL);
    proto external bool EndEntityAction(string historyPointName = string.Empty);
    proto external bool IsDoingEditAction();
    proto external bool BeginEditSequence(IEntitySource entSrc);
    proto external bool EndEditSequence(IEntitySource entSrc);
    proto external bool IsEditSequenceActive(IEntitySource entSrc);
    proto external bool UndoOrRedoIsRestoring();
    proto external bool IsCreatingEntityInWindow();
    proto external bool IsModifyingData();
    proto external bool IsPrefabEditMode();
    proto external IEntity SourceToEntity(IEntitySource entSrc);
    proto external IEntitySource EntityToSource(IEntity ent);
    proto external IEntitySource FindEntityByName(string name);
    proto external IEntitySource FindEntityByID(EntityID id);
    proto external int GetEditorEntityCount();
    proto external IEntitySource GetEditorEntity(int index);
    proto external int GetEntityCount(int subScene);
    proto external IEntitySource GetEntity(int subScene, int index);
    proto external bool HasCopiedEntities();
    proto external bool CopySelectedEntities();
    proto external bool PasteEntities();
    proto external bool PasteEntitiesAtMouseCursorPos();
    proto external bool DuplicateSelectedEntities();
    proto external bool CutSelectedEntities();
    //  virtual bool ModifyComponentTemplateKey(enf::EntitySource* entityTmplOwner, enf::EntityComponentSource* tmpl, enf::uint keyIndex, enf::CStr value)=0;
    proto external bool ParentEntity(notnull IEntitySource parent, notnull IEntitySource child, bool transformChildToParentSpace);
    proto external bool RemoveEntityFromParent(notnull IEntitySource child);
    proto external IEntityComponentSource CreateComponent(IEntitySource owner, string className);
    proto external bool DeleteComponent(IEntitySource owner, IEntityComponentSource component);
    proto external int GetSelectedEntitiesCount();
    proto external IEntitySource GetSelectedEntity(int n = 0);
    proto external void ClearEntitySelection();
    proto external void RemoveFromEntitySelection(notnull IEntitySource ent);
    proto external void SetPropertySelection(string id);
    proto external void UpdateSelectionGui();
    proto external bool CreateEntityTemplate(IEntitySource entitySrc, string templateFileAbs);
    proto external bool SaveEntityTemplate(IEntitySource tmpl);
    //create clone of entity
    proto external IEntitySource GetEntityUnderCursor();
    proto external bool RenameEntity(notnull IEntitySource ent, string newName);
    proto external int GetCurrentSubScene();
    proto external int GetNumSubScenes();
    proto external int GetScreenWidth();
    proto external int GetScreenHeight();
    proto external int GetMousePosX(bool clamped);
    proto external int GetMousePosY(bool clamped);
    proto external void ToggleGeneratorEvents(bool isEnabled);
    proto external bool AreGeneratorEventsEnabled();
    proto external void ModifyHeightMap(float xWorldPos, float zWorldPos, FilterMorphOperation operation, notnull TerrainToolDesc toolDesc, FilterMorphShape shape, FilterMorphLerpFunc interpFunc);
    proto external void ModifyHeightMapUserShape(float xWorldPos, float zWorldPos, FilterMorphOperation operation, notnull TerrainToolDesc toolDesc, array<float> userShape, UserShapeFilter userShapeFilter);
    proto external void ModifyLayers(float xWorldPos, float zWorldPos, FilterMorphOperation operation, notnull TerrainToolDesc toolDesc, FilterMorphShape shape, FilterMorphLerpFunc interpFunc);
    proto external void ModifyLayersUserShape(float xWorldPos, float zWorldPos, FilterMorphOperation operation, notnull TerrainToolDesc toolDesc, array<float> userShape, UserShapeFilter userShapeFilter);
    proto external bool BeginTerrainAction(TerrainToolType toolType, string historyPointName = string.Empty, string historyPointIcon = string.Empty);
    proto external void EndTerrainAction(string historyPointName = string.Empty);
    proto external float GetTerrainSurfaceY(float x, float z);
    proto external bool GetTerrainSurfaceTile(int terrainIndex, int tileX, int tileY, out notnull array<float> surfaceY);
    proto external bool SetTerrainSurfaceTile(int terrainIndex, int tileX, int tileY, notnull array<float> surfaceY);
    proto external int GetTerrainResolutionX(int terrainIndex = 0);
    proto external int GetTerrainResolutionY(int terrainIndex = 0);
    proto external int GetTerrainTilesX(int terrainIndex = 0);
    proto external int GetTerrainTilesY(int terrainIndex = 0);
    proto external float GetTerrainUnitScale(int terrainIndex = 0);
    proto external void RemoveTerrainFlatterEntity(IEntity entity, bool bUpdateTerrain = true);
    proto external void RemoveCommentEntity(IEntity entity);
    //--------------------------------- Rivers ----------------------------------
    proto external void RegenerateFlowMaps(bool preview = true, bool save = true, bool asyncReturn = true, bool noWarning = false);
    //--------------------------------- Shore -----------------------------------
    proto external void BuildShoreMap();
    proto external bool IsEntityVisible(IEntitySource entity);
    proto external void SetEntityVisible(IEntitySource entity, bool isVisible, bool recursive);
    proto external bool IsEntitySelected(IEntitySource entity);
    proto external bool IsEntitySelectedAsMain(IEntitySource entity);
    proto external bool IsEditMode();
    proto external bool IsGameMode();
    proto external void SetCamera(vector pos, vector lookVec);
    proto external void AddTerrainFlatterEntity(IEntity entity, vector mins, vector maxs, int iPriority, float fFalloffStart, float fFalloff, bool bForceUpdate = true, array<vector> updateMins = null, array<vector> updateMaxes = null);
    proto external void AddCommentEntity(IEntity entity, string comment, Color commentColor = Color.White);
    proto external bool TryGetTerrainSurfaceY(float x, float z, out float y);
    proto external void AddToEntitySelection(notnull IEntitySource ent);
    proto external void SetEntitySelection(notnull IEntitySource ent);
    [Obsolete("Use SetVariableValue instead!")]
    proto external bool ModifyEntityKey(notnull IEntitySource ent, string key, string value);
    [Obsolete("Use SetVariableValue instead!")]
    proto external bool ModifyComponentKey(notnull IEntitySource ent, string componentName, string key, string value);
    proto external IEntitySource CreateEntity(string className, string name, int layerId, IEntitySource parent, vector coords, vector angles);
    proto external IEntitySource CreateEntityExt(string className, string name, int layerId,  IEntitySource parent, vector coords, vector angles, int traceFlags);
    proto external IEntitySource CreateClonedEntity(notnull IEntitySource ent, string name, IEntitySource parent, bool cloneChildren);
    proto external IEntitySource CreateEntityInWindow(RenderTargetWidget window, int winX, int winY, string className, string name, int layerID);
    proto external IEntitySource CreateEntityInWindowEx(int windowType, int winX, int winY, string className, string name, int layerID);
    proto external bool ParentEntities(notnull IEntitySource parent, notnull array<IEntitySource> childs, bool transformChildToParentSpace);
    proto external bool DeleteEntity(notnull IEntitySource ent);
    proto external bool DeleteEntities(notnull array<IEntitySource> ents);
    proto external bool TraceWorldPos(int x, int y, TraceFlags traceFlags, out vector traceStart, out vector traceEnd, out vector traceDir, out IEntity hitEntity = null);
    proto external void GetWorldPath(out string path);
    proto external string GetEntityNiceName(IEntitySource entSrc);
    proto external string GenerateDefaultEntityName(IEntitySource entSrc);
    proto external bool SetVariableValue(notnull BaseContainer topLevel, array<ref ContainerIdPathEntry> containerIdPath, string key, string value);
    proto external bool ClearVariableValue(notnull BaseContainer topLevel, array<ref ContainerIdPathEntry> containerIdPath, string key);
    proto external bool CreateObjectVariableMember(notnull BaseContainer topLevel, array<ref ContainerIdPathEntry> containerIdPath, string key, string baseClassName);
    proto external bool CreateObjectArrayVariableMember(notnull BaseContainer topLevel, array<ref ContainerIdPathEntry> containerIdPath, string key, string baseClassName, int memberIndex);
    proto external bool RemoveObjectArrayVariableMember(notnull BaseContainer topLevel, array<ref ContainerIdPathEntry> containerIdPath, string key, int memberIndex);
    proto external bool ChangeObjectClass(notnull BaseContainer topLevel, array<ref ContainerIdPathEntry> containerIdPath, string baseClassName);
    proto external int ShowItemListDialog(string title, string message, int width, int height, notnull array<string> items, notnull out array<int> selectedItems, int currentItem);
    proto external bool AddPrefabMembers(IEntitySource prefabMember, notnull array<IEntitySource> members);
    proto external bool RemovePrefabMembers(notnull array<IEntitySource> members);
    proto external bool MoveEntitiesToPrefab(IEntitySource newParentInMap, IEntitySource newParentInPrefab, notnull array<IEntitySource> entitiesInMap, bool convertTransformations = true);
    proto external string GetCurrentToolName();
    proto external BaseWorld GetWorld();
    proto external string CreateSubsceneLayer(int subScene, string name, string parentPath = string.Empty);
    proto external string CreateSubsceneFolder(int subScene, string name, string parentPath = string.Empty);
    proto external bool RenameSubsceneFolder(int subScene, string itemPath, string newItemName);
    proto external bool DeleteSubsceneFolder(int subScene, string itemPath);
    proto external bool SetSubsceneFolderParent(int subScene, string itemPath, string parentPath);
    proto external void GetSubsceneFolders(int subscene, out notnull array<string> outItemPaths);
    proto external bool SetEntitySubsceneLayer(int subScene, IEntitySource pEntitySource, string itemPath);
    proto external string GetEntitySubsceneLayer(int subScene, IEntitySource pEntitySource);
    proto external string GetActiveSubsceneLayer(int subScene);
    proto external void SetActiveSubsceneLayer(int subScene, string layerPath);
    proto external int GetSubsceneLayerId(int subscene, string layerPath);
    proto external string GetSubsceneLayerPath(int subscene, int layerId);
    proto external bool IsSubsceneLayerVisible(int subscene, string layerPath);
    proto external bool IsEntityLayerVisible(int subscene, int layerId);
    proto external bool IsEntityLayerLocked(int subscene, int layerId);
    proto external bool IsEntityLayerLockedHierarchy(int subscene, int layerId);
    proto external void LockEntityLayer(int subscene, int layerId);
    proto external void UnlockEntityLayer(int subscene, int layerId);
    proto external int GetCurrentEntityLayerId();
}