Elaztek Developer Hub
Blamite Game Engine - Sapien (Library)  00433.02.16.25.2127.blamite
The level editor application for the Blamite Game Engine.
scenario.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <HEKGuerilla/components/tags/tags.h>
4 #include <HEKGuerilla/components/tags/fields/block/block.h>
5 #include <HEKGuerilla/components/projects/projects.h>
6 
7 #ifdef SAPIEN_LIB_EXPORTS
8 #define SAPIEN_LIB_API __declspec(dllexport)
9 #else
10 #define SAPIEN_LIB_API __declspec(dllimport)
11 #endif
12 
20 {
27 
32 
40  SAPIEN_LIB_API bool LoadScenario(std::string tag_path);
41 
53  SAPIEN_LIB_API bool LoadScenario_Stage1(std::string tag_path);
54 
65  SAPIEN_LIB_API bool LoadScenario_Stage2(std::string tag_path);
66 
77  SAPIEN_LIB_API bool LoadScenario_Stage3(std::string tag_path);
78 
88  SAPIEN_LIB_API bool LoadScenario_Stage4(std::string tag_path);
89 
94 
101  SAPIEN_LIB_API std::vector<std::string> GetPaletteTypes();
102 
111  SAPIEN_LIB_API BlamTagField_Block* GetPalette(BlamTag* scenario, std::string type);
112 
121  SAPIEN_LIB_API BlamTagField_Block* GetPaletteItems(BlamTag* scenario, std::string type);
122 
133  SAPIEN_LIB_API bool PlaceNewInstance(BlamVector3 position, std::string type, int index, int folder_index);
134 
145 }
BlamScenarioHierarchyNode_Object::world_object
BlamWorldObject * world_object
The world object that this node refers to.
Definition: hierarchy.h:178
Sapien::Scenario::GetActiveScenarioTag
SAPIEN_LIB_API BlamTag * GetActiveScenarioTag()
Retrieves the currently active scenario tag.
Definition: scenario.cpp:22
SAPIEN_LIB_API
#define SAPIEN_LIB_API
Definition: scenario.h:10
BlamScenarioHierarchy::Refresh
void Refresh()
Rebuilds the entire hierarchy data from world state and active scenario, cleaning up old data in the ...
Definition: BlamScenarioHierarchy.cpp:24
Sapien::Scenario::GetPaletteTypes
SAPIEN_LIB_API std::vector< std::string > GetPaletteTypes()
Retrieves a list of available scenario palette types, where each item is a string representing a long...
Definition: scenario.cpp:199
Sapien::Scenario::ReserveFolderIndex
SAPIEN_LIB_API int ReserveFolderIndex()
Reserves a new folder index within the current scenario.
Definition: scenario.cpp:291
active_scenario
BlamTag * active_scenario
Definition: scenario.cpp:20
BlamScenarioHierarchy::folder_ids
std::map< int, BlamScenarioHierarchyNode_Group * > folder_ids
A map containing a list of all folder IDs, and their respective node groups.
Definition: hierarchy.h:240
Sapien::Scenario::GetPalette
SAPIEN_LIB_API BlamTagField_Block * GetPalette(BlamTag *scenario, std::string type)
Retrieves a palette block from a scenario tag.
Definition: scenario.cpp:207
Sapien::Scenario::LoadScenario_Stage2
SAPIEN_LIB_API bool LoadScenario_Stage2(std::string tag_path)
Performs stage 2 of loading a scenario tag.
Definition: scenario.cpp:71
Sapien::Scenario::LoadScenario
SAPIEN_LIB_API bool LoadScenario(std::string tag_path)
Loads a scenario tag.
Definition: scenario.cpp:146
Sapien::Hierarchy::PrepareHierarchy
SAPIEN_LIB_API void PrepareHierarchy()
Prepares a new scenario hierarchy.
Definition: hierarchy.cpp:7
Sapien::Scenario::LoadScenario_Stage3
SAPIEN_LIB_API bool LoadScenario_Stage3(std::string tag_path)
Performs stage 3 of loading a scenario tag.
Definition: scenario.cpp:91
Sapien::Scenario::LoadScenario_Stage1
SAPIEN_LIB_API bool LoadScenario_Stage1(std::string tag_path)
Performs stage 1 of loading a scenario tag.
Definition: scenario.cpp:32
Sapien::Scenario
Namespace containing functions for interacting with a scenario.
Definition: scenario.h:19
BlamScenarioHierarchy
Class representing a scenario hierarchy.
Definition: hierarchy.h:223
Sapien::Scenario::PreScenarioLoad
SAPIEN_LIB_API void PreScenarioLoad()
Performs tasks that must be run prior to loading a new scenario tag.
Definition: scenario.cpp:27
BlamScenarioHierarchyNode_Object
Class representing an object hierarchy node.
Definition: hierarchy.h:175
Sapien::Scenario::LoadScenario_Stage4
SAPIEN_LIB_API bool LoadScenario_Stage4(std::string tag_path)
Performs stage 4 of loading a scenario tag.
Definition: scenario.cpp:114
scenario.h
Sapien::Scenario::SaveScenario
SAPIEN_LIB_API void SaveScenario()
Attempts to save any changes back to the scenario tag.
Definition: scenario_save.cpp:249
Sapien::Hierarchy::GetHierarchy
SAPIEN_LIB_API BlamScenarioHierarchy * GetHierarchy()
Retrieves the current scenario hierarchy.
Definition: hierarchy.cpp:24
config.h
Sapien::Scenario::GetPaletteItems
SAPIEN_LIB_API BlamTagField_Block * GetPaletteItems(BlamTag *scenario, std::string type)
Retrieves a palette items block from a scenario tag.
Definition: scenario.cpp:217
hierarchy.h
Sapien::Scenario::PlaceNewInstance
SAPIEN_LIB_API bool PlaceNewInstance(BlamVector3 position, std::string type, int index, int folder_index)
Places a new instance of a tag within the scenario.
Definition: scenario.cpp:227