Elaztek Developer Hub
Switch Project...
Blamite Game Engine - Sapien (Library)  00411.04.21.24.0017.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/projects/projects.h>
5 
6 #ifdef SAPIEN_LIB_EXPORTS
7 #define SAPIEN_LIB_API __declspec(dllexport)
8 #else
9 #define SAPIEN_LIB_API __declspec(dllimport)
10 #endif
11 
18 namespace Sapien::Scenario
19 {
25  SAPIEN_LIB_API BlamProject* GetActiveProject();
26 
32  SAPIEN_LIB_API BlamTag* GetActiveScenarioTag();
33 
42  SAPIEN_LIB_API bool LoadScenario(std::string project_name, std::string tag_path);
43 
54  SAPIEN_LIB_API bool LoadScenario_Stage1(std::string project_name, std::string tag_path);
55 
68  SAPIEN_LIB_API bool LoadScenario_Stage2(std::string project_name, std::string tag_path);
69 
81  SAPIEN_LIB_API bool LoadScenario_Stage3(std::string project_name, std::string tag_path);
82 
94  SAPIEN_LIB_API bool LoadScenario_Stage4(std::string project_name, std::string tag_path);
95 
106  SAPIEN_LIB_API bool LoadScenario_Stage5(std::string project_name, std::string tag_path);
107 
111  SAPIEN_LIB_API void SaveScenario();
112 }
BlamScenarioHierarchyNode::parent_node
BlamScenarioHierarchyNode * parent_node
The parent node, if any, of this hierarchy node.
Definition: hierarchy.h:43
BlamScenarioHierarchyNode_Object::world_object
BlamWorldObject * world_object
The world object that this node refers to.
Definition: hierarchy.h:169
Sapien::Scenario::GetActiveScenarioTag
SAPIEN_LIB_API BlamTag * GetActiveScenarioTag()
Retrieves the currently active scenario tag.
Definition: scenario.cpp:26
SAPIEN_LIB_API
#define SAPIEN_LIB_API
Definition: scenario.h:9
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
active_scenario
BlamTag * active_scenario
Definition: scenario.cpp:18
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:231
BlamScenarioHierarchyNode::GetType
BlamScenarioHierarchyNodeType GetType()
Retrieves the type of this node.
Definition: BlamScenarioHierarchyNode.cpp:20
Sapien::Scenario::GetActiveProject
SAPIEN_LIB_API BlamProject * GetActiveProject()
Retrieves the currently active project.
Definition: scenario.cpp:21
BlamScenarioHierarchyNode_Object::GetName
std::string GetName()
Retrieves the display name of the hierarchy node.
Definition: BlamScenarioHierarchyNode_Object.cpp:42
BlamScenarioHierarchyNode_Group::folder_id
int folder_id
The folder ID of this group. This number should be unique within the hierarchy.
Definition: hierarchy.h:88
Sapien::Scenario::LoadScenario
SAPIEN_LIB_API bool LoadScenario(std::string project_name, std::string tag_path)
Loads a scenario tag.
Definition: scenario.cpp:165
Sapien::Scenario::LoadScenario_Stage2
SAPIEN_LIB_API bool LoadScenario_Stage2(std::string project_name, std::string tag_path)
Performs stage 2 of loading a scenario tag.
Definition: scenario.cpp:52
Sapien::Scenario::LoadScenario_Stage3
SAPIEN_LIB_API bool LoadScenario_Stage3(std::string project_name, std::string tag_path)
Performs stage 3 of loading a scenario tag.
Definition: scenario.cpp:88
Sapien::Hierarchy::PrepareHierarchy
SAPIEN_LIB_API void PrepareHierarchy()
Prepares a new scenario hierarchy.
Definition: hierarchy.cpp:7
Sapien::Scenario
Namespace containing functions for interacting with a scenario.
Definition: scenario.h:18
BlamScenarioHierarchy
Class representing a scenario hierarchy.
Definition: hierarchy.h:214
BlamScenarioHierarchyNode::GetName
virtual std::string GetName()
Retrieves the display name of the hierarchy node.
Definition: BlamScenarioHierarchyNode.cpp:15
Sapien::Scenario::LoadScenario_Stage5
SAPIEN_LIB_API bool LoadScenario_Stage5(std::string project_name, std::string tag_path)
Performs stage 5 of loading a scenario tag.
Definition: scenario.cpp:142
BlamScenarioHierarchyNode
Base class for hierarchy nodes.
Definition: hierarchy.h:27
BlamScenarioHierarchyNode_Group::GetChildCount
int GetChildCount()
Retrieves the total number of child nodes.
Definition: BlamScenarioHierarchyNode_Group.cpp:69
BlamScenarioHierarchyNode_Object
Class representing an object hierarchy node.
Definition: hierarchy.h:166
BlamScenarioHierarchyNode_Group::GetChildAt
BlamScenarioHierarchyNode * GetChildAt(int index)
Retrieves the child node at the specified index.
Definition: BlamScenarioHierarchyNode_Group.cpp:59
scenario.h
BlamScenarioHierarchyNode_Group
Class representing a group hierarchy node.
Definition: hierarchy.h:82
Sapien::Scenario::SaveScenario
SAPIEN_LIB_API void SaveScenario()
Attempts to save any changes back to the scenario tag.
Definition: scenario.cpp:217
Sapien::Hierarchy::GetHierarchy
SAPIEN_LIB_API BlamScenarioHierarchy * GetHierarchy()
Retrieves the current scenario hierarchy.
Definition: hierarchy.cpp:24
active_project
BlamProject * active_project
Definition: scenario.cpp:19
config.h
Sapien::Scenario::LoadScenario_Stage4
SAPIEN_LIB_API bool LoadScenario_Stage4(std::string project_name, std::string tag_path)
Performs stage 4 of loading a scenario tag.
Definition: scenario.cpp:120
hierarchy.h
BlamScenarioHierarchyNodeType::Object
@ Object
Indicates the hierarchy node is a BlamScenarioHierarchyNode_Object.
Sapien::Scenario::LoadScenario_Stage1
SAPIEN_LIB_API bool LoadScenario_Stage1(std::string project_name, std::string tag_path)
Performs stage 1 of loading a scenario tag.
Definition: scenario.cpp:31