 |
Blamite Game Engine - blam!
00398.09.22.23.2015.blamite
The core library for the Blamite Game Engine.
|
Go to the documentation of this file.
5 #include <Strings/components/diagnostics/errors/errors.h>
8 #define BLAM_EXT_API __declspec(dllexport)
10 #define BLAM_EXT_API __declspec(dllimport)
56 BLAM BlamResult
LoadTagFromFile(std::string tag_path,
bool reload_if_already_loaded =
true);
int entry_size
The size of each block entry.
Definition: tags.h:179
BLAM BlamConfigurationFile * GetEngineConfiguration()
Definition: config.cpp:58
BLAM BlamResult SaveTag(std::string tag_path)
Saves a tag data to a file.
Definition: tag_io.cpp:773
#define BLAM_EXT_API
Definition: tag_io.h:10
Namespace containing functions related to tag data.
Definition: bitmap.h:196
void * entry_data_address
The address of the blocks' entry data.
Definition: tags.h:181
BLAM void LogEvent(std::string message)
Logs a message to the log and/or console.
Definition: aliases.cpp:142
BLAM int GetFieldSize(BlamTagFieldType type)
Definition: fields.cpp:100
void * LoadTagDataSection(int offset, int size, std::ifstream *tag_file)
Loads a tag data section from a file.
Definition: tag_io.cpp:83
std::string GetTagPath()
Retrieves the path of the tag that this tagref refers to.
Definition: tag_reference.cpp:45
@ Tags
Directory used for reading engine tags. Defaults to ./tags/
BLAM std::vector< BlamTagData * > * GetLoadedTags()
Retrieves the list of loaded tag data.
Definition: tags.cpp:151
Typedef for a bitfield32 field, used in tag data definitions.
Definition: tags.h:314
char path[256]
The tag's path.
Definition: tags.h:84
bool FixupClonedTagData(void *tag_address, int size, void *original_tag_address)
Definition: tag_io.cpp:267
BLAM BlamResult LoadTagFromFile(std::string tag_path, bool reload_if_already_loaded=true)
Loads a tag from the engine's tag directory (default is '.
Definition: tag_io.cpp:317
int data_size
The size of tagref_address.
Definition: tags.h:224
BlamTagFieldType referenced_field_type
Definition: tags.h:370
std::vector< char > BuildTagDataSection(void *section_data, int size, int start_offset)
Prepares a tag data section for saving.
Definition: tag_io.cpp:710
BLAM_EXT_API BlamTagClass * GetTagClass(std::string id)
Retrieves a tag class that matches the given string.
Definition: tagclass.cpp:64
#define USER_DATA_PATH(path)
Macro to quickly access a user data folder.
Definition: config.h:43
BLAM bool TagNeedsPostprocess(BlamTagData *tag_data)
Checks if a given tag requires additional post-processing.
Definition: tag_postprocess.cpp:95
#define BLAM
Definition: tag_io.h:14
signed char int8_t
Definition: stdint.h:11
Typedef for a bitfield8 field, used in tag data definitions.
Definition: tags.h:275
bool LoadTagDataSection__New(void *tag_address, int size, int header_size)
Definition: tag_io.cpp:219
bool SetTagPath(std::string new_path)
Updates the tag path.
Definition: BlamTagData.cpp:31
int int32_t
Definition: stdint.h:13
BLAM BlamTagData * CloneTag(BlamTagData *original_tag_data)
Definition: tag_io.cpp:825
std::string class_name_short
The short, 4-character name of the tag class.
Definition: tags.h:135
#define ENGINE_DATA_PATH(path)
Macro to quickly access a game engine data folder.
Definition: config.h:36
const BLAM char * GetVersion()
Retrieves the version of the engine in the following format:
Definition: engine_definitions.cpp:150
int entry_count
The number of entries within the tag block.
Definition: tags.h:182
int version
The tag class version. Should be incremented any time a tag class is modified whatsoever.
Definition: tags.h:136
BLAM void TagPostprocess(BlamTagData *tag_data)
Performs any required post-processing for a given tag.
Definition: tag_postprocess.cpp:115
Structure representing a tag reference.
Definition: tags.h:215
Structure representing a field reference.
Definition: tags.h:367
std::string class_name_long
The longer class name. Typically shown alongside short name for user-friendliness.
Definition: tags.h:134
BLAM std::string GetFieldName(BlamTagFieldType type)
Generates a string representation of a plugin field type.
Definition: fields.cpp:3
long long int64_t
Definition: stdint.h:14
BLAM BlamResult LoadTagFromMemoryBlock(char *address, int size, std::string tag_path, bool reload_if_already_loaded=true)
Definition: tag_io.cpp:536
BLAM BlamTagData * GetTagData(std::string tag_path)
Retrieves information for a given tag.
Definition: tags.cpp:80
std::vector< std::string > extra_tag_search_folders
Definition: tag_io.cpp:17
BLAM void ResolveAllTagReferences()
Attempts to resolve all tag references within all loaded tags.
Definition: tags.cpp:72
void LoadSectionTagReferences(char *address, int size, std::string tag_path)
Attempts to resolve any tag references within the given tag data section.
Definition: tag_io.cpp:26
bool data_is_tag
Whether or not tagref_address points to tag data, or the tag's path.
Definition: tags.h:222
void * data_address
The address of the referenced data.
Definition: tags.h:265
BLAM void LoadReferencedTags(std::string tag_path)
Attempts to resolve any tag references within a given tag.
Definition: tag_io.cpp:58
Typedef for a bitfield16 field, used in tag data definitions.
Definition: tags.h:290
Structure representing a data reference.
Definition: tags.h:261
bool HasReference()
Checks if a tag reference has a tag specified or not.
Definition: tag_reference.cpp:69
int tag_size
The size of the tag's data. Used on loading/writing tag files.
Definition: tags.h:139
int data_size
The size of the referenced data.
Definition: tags.h:266
uint32_t file_offset
Definition: tags.h:372
void * address
The address pointing to the start of the tag's data.
Definition: tags.h:71
TagOrigin origin
The origin of the tag.
Definition: tags.h:86
short int16_t
Definition: stdint.h:12
Class used to contain and access tag data.
Definition: tags.h:68
void * tagref_address
The address of the tagref data.
Definition: tags.h:221
BLAM_EXT_API void AddExtraTagFolder(std::string tag_folder)
Adds an additional folder to search when attempting to load a tag.
Definition: tag_io.cpp:53
@ Tags
Directory storing user-created tags. Defaults to {DataRoot}/tags/.
void * field_address
Definition: tags.h:371
int size
The size of the tag's data in memory.
Definition: tags.h:72
bool ResolveReference()
Attempts to resolve a tag reference.
Definition: tag_reference.cpp:7
Class representing a tag class.
Definition: tags.h:131
std::string tag_class
The tag's short class name.
Definition: tags.h:85
1.8.17