ModioModCreator - modio/modio-sdk-legacy GitHub Wiki
Object needed to create Mods (C compatible). Instead of editing the struct directly, we recommend you customize it using the ModioModCreator functions.
struct ModioModCreator
{
char* visible;
char* maturity_option;
char* logo;
char* name;
char* name_id;
char* summary;
char* description;
char* homepage_url;
char* metadata_blob;
ModioListNode* tags;
};
Functions
modioInitModCreator
void modioInitModCreator(ModioModCreator* mod_creator)
Initializes the mod creator object. Call this before any other ModioModCreator function.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
modioSetModCreatorVisible
void modioSetModCreatorVisible(ModioModCreator* mod_creator, bool visible)
Sets the mod creator's visibility.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
visible | u32 |
Mod's visibility |
modioSetModCreatorMaturityOption
void modioSetModCreatorMaturityOption(ModioModCreator* mod_creator, u32 maturity_option)
Sets the mod creators' maturity_option.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
maturity_option | u32 |
Mod's Maturity option. |
modioSetModCreatorLogoPath
void modioSetModCreatorLogoPath(ModioModCreator* mod_creator, char* logo_path)
Sets the logo local path for the mod creator.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
logo_path | char* |
Logo local path |
modioSetModCreatorName
void modioSetModCreatorName(ModioModCreator* mod_creator, char* name)
Sets the mod creator's name.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
name | char* |
Name of the mod |
modioSetModCreatorNameid
void modioSetModCreatorNameid(ModioModCreator* mod_creator, char* name_id)
Sets the mod creator's name id.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
name_id | char* |
Unique SEO-friendly mod uri |
modioSetModCreatorSummary
void modioSetModCreatorSummary(ModioModCreator* mod_creator, char* summary)
Sets the mod creator's summary.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
summary | char* |
Brief summary of the mod |
modioSetModCreatorDescription
void modioSetModCreatorDescription(ModioModCreator* mod_creator, char* description)
Sets the mod creator's description.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
description | char* |
Description of the mod |
modioSetModCreatorHomepage
void modioSetModCreatorHomepage(ModioModCreator* mod_creator, char* homepage)
Sets the mod creator's homepage url.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
homepage | char* |
Mod homepage URL |
modioSetModCreatorMetadataBlob
void modioSetModCreatorMetadataBlob(ModioModCreator* mod_creator, char* metadata_blob)
Sets the mod creator's metadata blob.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
metadata_blob | char* |
Metadata for the mod |
modioAddModCreatorTag
void modioAddModCreatorTag(ModioModCreator* mod_creator, char* tag)
Adds a tag to the mod creator.
Name | Type | Description |
---|---|---|
mod_creator | ModioModCreator* |
ModioModCreator object to customize |
tag | char* |
Add a tag to the mod |
modioFreeModCreator
void modioFreeModCreator(ModioModCreator* mod_creator)
Frees the mod creator 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_creator | ModioModCreator* |
ModioModCreator object to customize |