ModioModEditor - modio/modio-sdk-legacy GitHub Wiki
Object needed to update Mods (C compatible). Instead of editing the struct directly, we recommend you customize it using the ModioModEditor functions.
struct ModioModEditor
{
char* visible;
char* status;
char* maturity_option;
char* name;
char* name_id;
char* summary;
char* description;
char* homepage_url;
char* modfile;
char* metadata_blob;
};
Functions
modioInitModEditor
void modioInitModEditor(ModioModEditor* mod_editor)
Initializes the ModioModEditor object. Call this before any other mod editor function.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
modioSetModEditorVisible
void modioSetModEditorVisible(ModioModCreator* mod_creator, u32 visible)
Sets the mod editor's visibility.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
visible | u32 |
Mod's visibility |
modioSetModEditorMaturityOption
void modioSetModEditorMaturityOption(ModioModCreator* mod_creator, u32 maturity_option)
Set's the mod editor's maturity option.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
maturity_option | u32 |
Mod's Maturity option. |
modioSetModEditorStatus
void modioSetModEditorStatus(ModioModCreator* mod_creator, u32 visible)
Set's the mod editor status.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
status | u32 |
Mod's status |
modioSetModEditorName
void modioSetModEditorName(ModioModEditor* mod_editor, char* name)
Set's the mod editor's name.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
name | char* |
Mod's name |
modioSetModEditorNameid
void modioSetModEditorNameid(ModioModEditor* mod_editor, char* name_id)
Sets the mod editor's name id.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
name_id | char* |
Unique SEO-friendly mod uri. |
modioSetModEditorSummary
void modioSetModEditorSummary(ModioModEditor* mod_editor, char* summary)
Set's the mod editor's summary.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
summary | char* |
Brief summary of the mod. |
modioSetModEditorDescription
void modioSetModEditorDescription(ModioModEditor* mod_editor, char* description)
Set's the mod editor's description.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
description | char* |
Description of the mod |
modioSetModEditorHomepage
void modioSetModEditorHomepage(ModioModEditor* mod_editor, char* homepage)
Sets the mod editor's homepage URL.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
homepage | char* |
Mod homepage URL |
modioSetModEditorModfile
void modioSetModEditorModfile(ModioModCreator* mod_creator, u32 modfile)
Sets the mod editor's modfile id.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
modfile | u32 |
Modfile unique identifier |
modioSetModEditorMetadataBlob
void modioSetModEditorMetadataBlob(ModioModEditor* mod_editor, char* metadata_blob)
Sets the mod editor's metadata blob.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |
metadata_blob | char* |
Metadata for the mod |
modioFreeModEditor
void modioFreeModEditor(ModioModEditor* mod_editor)
Frees the mod editor object memory. Use this after calling the edit mod function. Note: You don't have to wait for the callback to use this function.
Name | Type | Description |
---|---|---|
mod_editor | ModioModEditor* |
ModioModEditor object to customize |