HomeCommandsExamplesGetting Started With ScriptsGlobal Keywords
ModMods
BracketDumpersBracketHandlersBracketValidatorsResourceLocationBracketHandler
Previous
Mod BlockPredicateBuilder
Next

Mods

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.api.mod.Mods;

Description

Holds information on all the mods that are registered. Can be accessed using the loadedMods global keyword

Operators

.
.(modid as string) as Mod
Gets a specific mod
script.zs
// Mods.(modid as string) as Mod
myMods.myString

Parameters:

modid Type: string

Return Type: Mod

[]
[](modid as string) as Mod
script.zs
// Mods[modid as string] as Mod
myMods[myString]

Parameters:

modid Type: string

Return Type: Mod

Members

getMod
getMod(modid as string) as Mod
Gets a specific mod

Returns: a specific Mod

script.zs
// Mods.getMod(modid as string) as Mod;
myMods.getMod("minecraft");

Parameters:

modid Type: string

Return Type: Mod

isModLoaded
isModLoaded(modid as string) as bool
Checks if a mod is laoded

Returns: true if the mod is loaded

script.zs
// Mods.isModLoaded(modid as string) as bool;
myMods.isModLoaded("minecraft");

Parameters:

modid Type: string - modid to check

Return Type: bool

mods
Getter
Gets a list of all mods in the game
script.zs
// Mods.mods as List<Mod>
myMods.mods

Return Type: List<Mod>

mods() as List<Mod>
Gets a list of all mods in the game

Returns: list of Mod

script.zs
// Mods.mods() as List<Mod>;
myMods.mods();

Return Type: List<Mod>

size
Getter
Gets the amount of mods loaded
script.zs
// Mods.size as int
myMods.size

Return Type: int

size() as int
Gets the amount of mods loaded

Returns: The amount of mods that are loaded

script.zs
// Mods.size() as int;
myMods.size();

Return Type: int

Previous
Mod BlockPredicateBuilder
Next