├── docs ├── groovyscript │ ├── mods │ │ ├── gtceu │ │ │ ├── heating_coils.md │ │ │ ├── terminal.md │ │ │ ├── !navigation.md │ │ │ └── recipes.md │ │ ├── chisel │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── advancedmortars │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── draconicevolution │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── compactmachines3 │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── avaritia │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── inspirations │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── evilcraft │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── forestry │ │ │ └── forestry.md │ │ ├── harkenscythe │ │ │ └── index.md │ │ ├── woot │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── integrateddynamics │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── extendedcrafting │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── appliedenergistics2 │ │ │ ├── !navigation.md │ │ │ ├── index.md │ │ │ ├── cannon_ammo.md │ │ │ └── spatial.md │ │ ├── bloodmagic │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── enderio │ │ │ ├── !navigation.md │ │ │ ├── index.md │ │ │ ├── fluid_fuel.md │ │ │ └── fluid_coolant.md │ │ ├── actuallyadditions │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── thaumcraft │ │ │ ├── !navigation.md │ │ │ ├── index.md │ │ │ ├── warp.md │ │ │ └── loot_bag.md │ │ ├── pyrotech │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── botania │ │ │ ├── !navigation.md │ │ │ ├── index.md │ │ │ ├── knowledge.md │ │ │ ├── orechid.md │ │ │ ├── category.md │ │ │ └── orechid_ignem.md │ │ ├── immersiveengineering │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── astralsorcery │ │ │ ├── !navigation.md │ │ │ ├── index.md │ │ │ └── perk_tree_config.md │ │ ├── roots │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── jei │ │ │ └── jei.md │ │ ├── mekanism │ │ │ ├── !navigation.md │ │ │ └── index.md │ │ ├── !navigation.md │ │ └── thermal │ │ │ └── pulverizer.md │ ├── minecraft │ │ ├── events │ │ │ ├── generic_event.md │ │ │ ├── registry_event │ │ │ │ ├── new_registry.md │ │ │ │ ├── registry_event.md │ │ │ │ ├── register.md │ │ │ │ └── missing_mappings.md │ │ │ ├── world_event │ │ │ │ ├── world_event.md │ │ │ │ ├── load.md │ │ │ │ ├── save.md │ │ │ │ ├── unload.md │ │ │ │ ├── create_spawn_position.md │ │ │ │ └── potential_spawns.md │ │ │ ├── biome_event │ │ │ │ ├── biome_event.md │ │ │ │ ├── get_grass_color.md │ │ │ │ ├── get_water_color.md │ │ │ │ ├── get_foliage_color.md │ │ │ │ ├── biome_color.md │ │ │ │ ├── create_decorator.md │ │ │ │ └── get_village_block_i_d.md │ │ │ ├── entity_event │ │ │ │ ├── entity_event.md │ │ │ │ ├── entity_constructing.md │ │ │ │ ├── can_update.md │ │ │ │ └── entering_chunk.md │ │ │ ├── world_type_event │ │ │ │ ├── world_type_event.md │ │ │ │ ├── biome_size.md │ │ │ │ └── init_biome_gens.md │ │ │ ├── explosion_event │ │ │ │ ├── explosion_event.md │ │ │ │ ├── start.md │ │ │ │ └── detonate.md │ │ │ ├── chunk_watch_event │ │ │ │ ├── watch.md │ │ │ │ ├── un_watch.md │ │ │ │ └── chunk_watch_event.md │ │ │ ├── difficulty_change_event.md │ │ │ ├── chunk_event │ │ │ │ ├── load.md │ │ │ │ ├── unload.md │ │ │ │ └── chunk_event.md │ │ │ ├── chunk_generator_event │ │ │ │ ├── chunk_generator_event.md │ │ │ │ ├── replace_biome_blocks.md │ │ │ │ └── init_noise_field.md │ │ │ ├── block_event │ │ │ │ ├── block_event.md │ │ │ │ ├── create_fluid_source_event.md │ │ │ │ ├── portal_spawn_event.md │ │ │ │ ├── entity_multi_place_event.md │ │ │ │ ├── multi_place_event.md │ │ │ │ ├── farmland_trample_event.md │ │ │ │ ├── neighbor_notify_event.md │ │ │ │ ├── break_event.md │ │ │ │ ├── place_event.md │ │ │ │ ├── entity_place_event.md │ │ │ │ ├── fluid_place_block_event.md │ │ │ │ ├── harvest_drops_event.md │ │ │ │ └── crop_grow_event.md │ │ │ ├── furnace_fuel_burn_time_event.md │ │ │ ├── game_rule_change_event.md │ │ │ ├── entity_mob_griefing_event.md │ │ │ ├── item_event.md │ │ │ ├── entity_join_world_event.md │ │ │ ├── minecart_event.md │ │ │ ├── entity_travel_to_dimension_event.md │ │ │ ├── chunk_data_event │ │ │ │ ├── load.md │ │ │ │ ├── save.md │ │ │ │ └── chunk_data_event.md │ │ │ ├── living_event │ │ │ │ ├── living_event.md │ │ │ │ ├── living_jump_event.md │ │ │ │ └── living_update_event.md │ │ │ ├── zombie_event │ │ │ │ ├── zombie_event.md │ │ │ │ └── summon_aid_event.md │ │ │ ├── item_toss_event.md │ │ │ ├── living_death_event.md │ │ │ ├── minecart_update_event.md │ │ │ ├── entity_struck_by_lightning_event.md │ │ │ ├── potion_event │ │ │ │ ├── potion_expiry_event.md │ │ │ │ ├── potion_event.md │ │ │ │ ├── potion_applicable_event.md │ │ │ │ ├── potion_remove_event.md │ │ │ │ └── potion_added_event.md │ │ │ ├── projectile_impact_event │ │ │ │ ├── projectile_impact_event.md │ │ │ │ ├── arrow.md │ │ │ │ ├── fireball.md │ │ │ │ └── throwable.md │ │ │ ├── minecart_collision_event.md │ │ │ ├── item_expire_event.md │ │ │ ├── player_event │ │ │ │ ├── player_event.md │ │ │ │ ├── start_tracking.md │ │ │ │ ├── stop_tracking.md │ │ │ │ ├── clone.md │ │ │ │ ├── visibility.md │ │ │ │ ├── name_format.md │ │ │ │ ├── harvest_check.md │ │ │ │ ├── save_to_file.md │ │ │ │ ├── load_from_file.md │ │ │ │ └── break_speed.md │ │ │ ├── living_heal_event.md │ │ │ ├── living_entity_use_item_event │ │ │ │ ├── start.md │ │ │ │ ├── stop.md │ │ │ │ ├── tick.md │ │ │ │ ├── living_entity_use_item_event.md │ │ │ │ └── finish.md │ │ │ ├── living_set_attack_target_event.md │ │ │ ├── living_attack_event.md │ │ │ ├── player_brewed_potion_event.md │ │ │ ├── player_drops_event.md │ │ │ ├── player_pickup_xp_event.md │ │ │ ├── advancement_event.md │ │ │ ├── attack_entity_event.md │ │ │ ├── player_container_event │ │ │ │ ├── close.md │ │ │ │ ├── open.md │ │ │ │ └── player_container_event.md │ │ │ ├── living_spawn_event │ │ │ │ ├── allow_despawn.md │ │ │ │ ├── special_spawn.md │ │ │ │ ├── living_spawn_event.md │ │ │ │ └── check_spawn.md │ │ │ ├── init_map_gen_event.md │ │ │ ├── sapling_grow_tree_event.md │ │ │ ├── loot_table_load_event.md │ │ │ ├── merchant_trade_offers_event.md │ │ │ ├── throwable_impact_event.md │ │ │ ├── player_interact_event │ │ │ │ ├── left_click_empty.md │ │ │ │ ├── right_click_item.md │ │ │ │ ├── right_click_empty.md │ │ │ │ ├── entity_interact.md │ │ │ │ ├── entity_interact_specific.md │ │ │ │ ├── left_click_block.md │ │ │ │ ├── right_click_block.md │ │ │ │ └── player_interact_event.md │ │ │ ├── animal_tame_event.md │ │ │ ├── living_destroy_block_event.md │ │ │ ├── living_pack_size_event.md │ │ │ ├── server_chat_event.md │ │ │ ├── living_hurt_event.md │ │ │ ├── player_set_spawn_event.md │ │ │ ├── get_collision_boxes_event.md │ │ │ ├── living_damage_event.md │ │ │ ├── entity_item_pickup_event.md │ │ │ ├── village_siege_event.md │ │ │ ├── note_block_event │ │ │ │ ├── change.md │ │ │ │ ├── play.md │ │ │ │ └── note_block_event.md │ │ │ ├── looting_level_event.md │ │ │ ├── sleeping_time_check_event.md │ │ │ ├── player_destroy_item_event.md │ │ │ ├── sleeping_location_check_event.md │ │ │ ├── player_wake_up_event.md │ │ │ ├── command_event.md │ │ │ ├── populate_chunk_event │ │ │ │ ├── populate.md │ │ │ │ └── populate_chunk_event.md │ │ │ ├── baby_entity_spawn_event.md │ │ │ ├── init_noise_gens_event.md │ │ │ ├── minecart_interact_event.md │ │ │ ├── attach_capabilities_event.md │ │ │ ├── living_fall_event.md │ │ │ ├── ore_gen_event │ │ │ │ ├── generate_minable.md │ │ │ │ └── ore_gen_event.md │ │ │ ├── decorate_biome_event │ │ │ │ ├── decorate.md │ │ │ │ └── decorate_biome_event.md │ │ │ ├── living_drops_event.md │ │ │ ├── living_equipment_change_event.md │ │ │ ├── player_flyable_fall_event.md │ │ │ ├── enchantment_level_set_event.md │ │ │ ├── entity_mount_event.md │ │ │ ├── use_hoe_event.md │ │ │ ├── living_experience_drop_event.md │ │ │ ├── anvil_update_event.md │ │ │ ├── item_fished_event.md │ │ │ ├── arrow_loose_event.md │ │ │ ├── potion_color_calculation_event.md │ │ │ ├── player_sleep_in_bed_event.md │ │ │ ├── item_tooltip_event.md │ │ │ ├── critical_hit_event.md │ │ │ ├── bonemeal_event.md │ │ │ ├── ender_teleport_event.md │ │ │ ├── arrow_nock_event.md │ │ │ ├── fill_bucket_event.md │ │ │ ├── anvil_repair_event.md │ │ │ ├── play_sound_at_entity_event.md │ │ │ ├── potion_brew_event.md │ │ │ └── living_knock_back_event.md │ │ ├── loot │ │ │ └── loot.md │ │ ├── !navigation.md │ │ ├── ingredient.md │ │ ├── furnace.md │ │ ├── ore_dictionary.md │ │ └── tooltip.md │ ├── content │ │ ├── !navigation.md │ │ ├── creative_tab.md │ │ ├── content.md │ │ ├── item.md │ │ └── block.md │ ├── !navigation.md │ └── external_compat.md ├── assets │ └── images │ │ └── slice_n_splice_recipe.png ├── introduction │ └── !navigation.md ├── groovy │ ├── !navigation.md │ ├── strings.md │ ├── closure.md │ ├── maps.md │ ├── lists.md │ └── loops.md ├── stylesheets │ └── extra.css └── index.md ├── .gitignore ├── requirements.txt ├── .readthedocs.yaml ├── README.md └── overrides ├── .icons └── custom │ └── curseforge.svg └── partials ├── source-file.html └── actions.html /docs/groovyscript/mods/gtceu/heating_coils.md: -------------------------------------------------------------------------------- 1 | [WIP] -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/generic_event.md: -------------------------------------------------------------------------------- 1 | TODO 2 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/gtceu/terminal.md: -------------------------------------------------------------------------------- 1 | # Terminal 2 | [WIP] -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /.idea/workspace.xml 4 | 5 | .idea/ 6 | *.iml -------------------------------------------------------------------------------- /docs/assets/images/slice_n_splice_recipe.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CleanroomMC/GroovyScript-Docs/HEAD/docs/assets/images/slice_n_splice_recipe.png -------------------------------------------------------------------------------- /docs/groovyscript/mods/chisel/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Chisel](./index.md) 8 | * [Carving](./carving.md) 9 | -------------------------------------------------------------------------------- /docs/introduction/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Introduction](../index.md) 8 | * [Getting Started](./getting_started.md) 9 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/advancedmortars/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Advanced Mortars](./index.md) 8 | * [Mortar](./mortar.md) 9 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/draconicevolution/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Draconic Evolution](./index.md) 8 | * [Fusion](./fusion.md) 9 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/chisel/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Chisel 7 | 8 | ## Categories 9 | 10 | Has 1 subcategories. 11 | 12 | * [Carving](./carving.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/compactmachines3/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Compact Machines 3](./index.md) 8 | * [Miniaturization](./miniaturization.md) 9 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # Direct dependencies 2 | jinja2>=3.0.2 3 | markdown>=3.2 4 | mkdocs>=1.3.1 5 | mkdocs-material>=9.4.7 6 | mkdocs-literate-nav>=0.6.1 7 | mkdocs-git-revision-date-localized-plugin>=1.2.1 8 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/advancedmortars/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Advanced Mortars 7 | 8 | ## Categories 9 | 10 | Has 1 subcategories. 11 | 12 | * [Mortar](./mortar.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/draconicevolution/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Draconic Evolution 7 | 8 | ## Categories 9 | 10 | Has 1 subcategories. 11 | 12 | * [Fusion](./fusion.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/avaritia/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Avaritia](./index.md) 8 | * [Compressor](./compressor.md) 9 | * [Extreme Crafting](./extreme_crafting.md) 10 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/inspirations/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Inspirations](./index.md) 8 | * [Anvil Smashing](./anvil_smashing.md) 9 | * [Cauldron](./cauldron.md) 10 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/compactmachines3/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Compact Machines 3 7 | 8 | ## Categories 9 | 10 | Has 1 subcategories. 11 | 12 | * [Miniaturization](./miniaturization.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/evilcraft/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [EvilCraft](./index.md) 8 | * [Blood Infuser](./blood_infuser.md) 9 | * [Environmental Accumulator](./environmental_accumulator.md) 10 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/forestry/forestry.md: -------------------------------------------------------------------------------- 1 | # Forestry 2 | 3 | Documentation is not yet available for Forestry. 4 | In the meantime have a look at some examples [here](https://github.com/CleanroomMC/GroovyScript/blob/master/examples/forestry.groovy). -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/registry_event/new_registry.md: -------------------------------------------------------------------------------- 1 | # RegistryEvent.NewRegistry 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.RegistryEvent.NewRegistry 6 | ``` 7 | 8 | ## Methods 9 | -------------------------------------------------------------------------------- /docs/groovyscript/content/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Content](./content.md) 8 | * [Items](./item.md) 9 | * [Blocks](./block.md) 10 | * [Fluids](./fluid.md) 11 | * [Creative Tabs](./creative_tab.md) 12 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/avaritia/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Avaritia 7 | 8 | ## Categories 9 | 10 | Has 2 subcategories. 11 | 12 | * [Compressor](./compressor.md) 13 | 14 | * [Extreme Crafting](./extreme_crafting.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/inspirations/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Inspirations 7 | 8 | ## Categories 9 | 10 | Has 2 subcategories. 11 | 12 | * [Anvil Smashing](./anvil_smashing.md) 13 | 14 | * [Cauldron](./cauldron.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/groovyscript/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Resource Location](./rl.md) 8 | * [Minecraft](./minecraft/) 9 | * [Content](./content/) 10 | * [External Mod Compat](./external_compat.md) 11 | * [Mods](./mods/) 12 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/gtceu/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | * [Recipes](./recipes.md) 7 | * [Materials](./material.md) 8 | * [Heating Coils](./heating_coils.md) 9 | * [Terminal](./terminal.md) 10 | * [Multiblocks](./multiblock.md) 11 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/harkenscythe/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | aside: false 3 | --- 4 | 5 | 6 | # Harken Scythe: Resharpened 7 | 8 | ## Categories 9 | 10 | Has 2 subcategories. 11 | 12 | * [Altar of Blood](./blood_altar.md) 13 | 14 | * [Altar of Souls](./soul_altar.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/evilcraft/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # EvilCraft 7 | 8 | ## Categories 9 | 10 | Has 2 subcategories. 11 | 12 | * [Blood Infuser](./blood_infuser.md) 13 | 14 | * [Environmental Accumulator](./environmental_accumulator.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/groovy/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Introduction](./introduction.md) 8 | * [Strings](./strings.md) 9 | * [Lists](./lists.md) 10 | * [Maps](./maps.md) 11 | * [Loops](./loops.md) 12 | * [Builders](./builder.md) 13 | * [Closures](./closure.md) 14 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_event/world_event.md: -------------------------------------------------------------------------------- 1 | # WorldEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.WorldEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.World getWorld() 11 | ``` 12 | 13 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/woot/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Woot](./index.md) 8 | * [Drops](./drops.md) 9 | * [Mob Config](./mob_config.md) 10 | * [Policy](./policy.md) 11 | * [Spawning](./spawning.md) 12 | * [Stygian Iron Anvil](./stygian_iron_anvil.md) 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/biome_event.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.BiomeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.biome.Biome getBiome() 11 | ``` 12 | 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_event/entity_event.md: -------------------------------------------------------------------------------- 1 | # EntityEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.entity.Entity getEntity() 11 | ``` 12 | 13 | -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # Required 2 | version: 2 3 | 4 | # Set the version of Python and other tools you might need 5 | build: 6 | os: ubuntu-22.04 7 | tools: 8 | python: "3.11" 9 | 10 | mkdocs: 11 | configuration: mkdocs.yml 12 | 13 | python: 14 | install: 15 | - requirements: requirements.txt 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_type_event/world_type_event.md: -------------------------------------------------------------------------------- 1 | # WorldTypeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.WorldTypeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.WorldType getWorldType() 11 | ``` 12 | 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/loot/loot.md: -------------------------------------------------------------------------------- 1 | # Loot 2 | 3 | This is not a mod compat. It is a powerful standalone implementation to edit any loot tables. 4 | 5 | Documentation is not yet available for tweaking loot tables. 6 | In the meantime have a look at some examples [here](https://github.com/CleanroomMC/GroovyScript/blob/master/examples/loot.groovy). -------------------------------------------------------------------------------- /docs/groovyscript/mods/integrateddynamics/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Integrated Dynamics](./index.md) 8 | * [Drying Basin](./drying_basin.md) 9 | * [Mechanical Drying Basin](./mechanical_drying_basin.md) 10 | * [Mechanical Squeezer](./mechanical_squeezer.md) 11 | * [Squeezer](./squeezer.md) 12 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/extendedcrafting/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Extended Crafting](./index.md) 8 | * [Combination Crafting](./combination_crafting.md) 9 | * [Compression Crafting](./compression_crafting.md) 10 | * [Ender Crafting](./ender_crafting.md) 11 | * [Table Crafting](./table_crafting.md) 12 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/woot/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Woot 7 | 8 | ## Categories 9 | 10 | Has 5 subcategories. 11 | 12 | * [Drops](./drops.md) 13 | 14 | * [Mob Config](./mob_config.md) 15 | 16 | * [Policy](./policy.md) 17 | 18 | * [Spawning](./spawning.md) 19 | 20 | * [Stygian Iron Anvil](./stygian_iron_anvil.md) 21 | 22 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/appliedenergistics2/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Applied Energistics 2](./index.md) 8 | * [P2P Attunement](./attunement.md) 9 | * [Cannon Ammo](./cannon_ammo.md) 10 | * [Grinder](./grinder.md) 11 | * [Inscriber](./inscriber.md) 12 | * [Spatial Storage Allowed Tile Entities](./spatial.md) 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/explosion_event/explosion_event.md: -------------------------------------------------------------------------------- 1 | # ExplosionEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ExplosionEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.World getWorld() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.world.Explosion getExplosion() 15 | ``` 16 | 17 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/registry_event/registry_event.md: -------------------------------------------------------------------------------- 1 | # RegistryEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.RegistryEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [GenericEvent](../generic_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/integrateddynamics/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Integrated Dynamics 7 | 8 | ## Categories 9 | 10 | Has 4 subcategories. 11 | 12 | * [Drying Basin](./drying_basin.md) 13 | 14 | * [Mechanical Drying Basin](./mechanical_drying_basin.md) 15 | 16 | * [Mechanical Squeezer](./mechanical_squeezer.md) 17 | 18 | * [Squeezer](./squeezer.md) 19 | 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_event/load.md: -------------------------------------------------------------------------------- 1 | # WorldEvent.Load 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.WorldEvent.Load 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_event/save.md: -------------------------------------------------------------------------------- 1 | # WorldEvent.Save 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.WorldEvent.Save 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/explosion_event/start.md: -------------------------------------------------------------------------------- 1 | # ExplosionEvent.Start 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ExplosionEvent.Start 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ExplosionEvent](explosion_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_event/unload.md: -------------------------------------------------------------------------------- 1 | # WorldEvent.Unload 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.WorldEvent.Unload 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/extendedcrafting/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Extended Crafting 7 | 8 | ## Categories 9 | 10 | Has 4 subcategories. 11 | 12 | * [Combination Crafting](./combination_crafting.md) 13 | 14 | * [Compression Crafting](./compression_crafting.md) 15 | 16 | * [Ender Crafting](./ender_crafting.md) 17 | 18 | * [Table Crafting](./table_crafting.md) 19 | 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | * [Crafting](./crafting.md) 7 | * [Crafting with Builders](./crafting_builders.md) 8 | * [Furnace](./furnace.md) 9 | * [Items](./item.md) 10 | * [Ore Dictionary](./ore_dictionary.md) 11 | * [IIngredient](./ingredient) 12 | * [Tooltips](./tooltip.md) 13 | * [Loot](./loot/loot.md) 14 | * [Events](./events/) 15 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_watch_event/watch.md: -------------------------------------------------------------------------------- 1 | # ChunkWatchEvent.Watch 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkWatchEvent.Watch 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkWatchEvent](chunk_watch_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_watch_event/un_watch.md: -------------------------------------------------------------------------------- 1 | # ChunkWatchEvent.UnWatch 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkWatchEvent.UnWatch 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkWatchEvent](chunk_watch_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/difficulty_change_event.md: -------------------------------------------------------------------------------- 1 | # DifficultyChangeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.DifficultyChangeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.EnumDifficulty getOldDifficulty() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.world.EnumDifficulty getDifficulty() 15 | ``` 16 | 17 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/appliedenergistics2/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Applied Energistics 2 7 | 8 | ## Categories 9 | 10 | Has 5 subcategories. 11 | 12 | * [P2P Attunement](./attunement.md) 13 | 14 | * [Cannon Ammo](./cannon_ammo.md) 15 | 16 | * [Grinder](./grinder.md) 17 | 18 | * [Inscriber](./inscriber.md) 19 | 20 | * [Spatial Storage Allowed Tile Entities](./spatial.md) 21 | 22 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/bloodmagic/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Blood Magic: Alchemical Wizardry](./index.md) 8 | * [Alchemy Array](./alchemy_array.md) 9 | * [Alchemy Table](./alchemy_table.md) 10 | * [Blood Altar](./blood_altar.md) 11 | * [Meteor](./meteor.md) 12 | * [Sacrificial](./sacrificial.md) 13 | * [Tartaric Forge](./tartaric_forge.md) 14 | * [Tranquility](./tranquility.md) 15 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_event/load.md: -------------------------------------------------------------------------------- 1 | # ChunkEvent.Load 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkEvent.Load 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkEvent](../chunk_event/chunk_event.md), [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_generator_event/chunk_generator_event.md: -------------------------------------------------------------------------------- 1 | # ChunkGeneratorEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.ChunkGeneratorEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.gen.IChunkGenerator getGenerator() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.world.gen.IChunkGenerator getGen() 15 | ``` 16 | 17 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/get_grass_color.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent.GetGrassColor 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.BiomeEvent.GetGrassColor 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BiomeColor](biome_color.md), [BiomeEvent](biome_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/get_water_color.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent.GetWaterColor 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.BiomeEvent.GetWaterColor 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BiomeColor](biome_color.md), [BiomeEvent](biome_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_event/unload.md: -------------------------------------------------------------------------------- 1 | # ChunkEvent.Unload 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkEvent.Unload 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkEvent](../chunk_event/chunk_event.md), [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_event/entity_constructing.md: -------------------------------------------------------------------------------- 1 | # EntityEvent.EntityConstructing 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityEvent.EntityConstructing 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/get_foliage_color.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent.GetFoliageColor 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.BiomeEvent.GetFoliageColor 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BiomeColor](biome_color.md), [BiomeEvent](biome_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/block_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.block.state.IBlockState getState() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.util.math.BlockPos getPos() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.world.World getWorld() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/furnace_fuel_burn_time_event.md: -------------------------------------------------------------------------------- 1 | # FurnaceFuelBurnTimeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.furnace.FurnaceFuelBurnTimeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | int getBurnTime() 11 | ``` 12 | 13 | ```groovy 14 | void setBurnTime(int arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.item.ItemStack getItemStack() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/game_rule_change_event.md: -------------------------------------------------------------------------------- 1 | # GameRuleChangeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.GameRuleChangeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.GameRules getRules() 11 | ``` 12 | 13 | ```groovy 14 | java.lang.String getRuleName() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.server.MinecraftServer getServer() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_event/chunk_event.md: -------------------------------------------------------------------------------- 1 | # ChunkEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.world.chunk.Chunk getChunk() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_mob_griefing_event.md: -------------------------------------------------------------------------------- 1 | # EntityMobGriefingEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityMobGriefingEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/item_event.md: -------------------------------------------------------------------------------- 1 | # ItemEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.item.ItemEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.item.EntityItem getEntityItem() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_join_world_event.md: -------------------------------------------------------------------------------- 1 | # EntityJoinWorldEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityJoinWorldEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.world.World getWorld() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/minecart_event.md: -------------------------------------------------------------------------------- 1 | # MinecartEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.minecart.MinecartEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.item.EntityMinecart getMinecart() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_travel_to_dimension_event.md: -------------------------------------------------------------------------------- 1 | # EntityTravelToDimensionEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityTravelToDimensionEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getDimension() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/create_fluid_source_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.CreateFluidSourceEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.CreateFluidSourceEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_data_event/load.md: -------------------------------------------------------------------------------- 1 | # ChunkDataEvent.Load 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkDataEvent.Load 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkDataEvent](chunk_data_event.md), [ChunkEvent](../chunk_event/chunk_event.md), [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_data_event/save.md: -------------------------------------------------------------------------------- 1 | # ChunkDataEvent.Save 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkDataEvent.Save 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkDataEvent](chunk_data_event.md), [ChunkEvent](../chunk_event/chunk_event.md), [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_event/living_event.md: -------------------------------------------------------------------------------- 1 | # LivingEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.EntityLivingBase getEntityLiving() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_event/living_jump_event.md: -------------------------------------------------------------------------------- 1 | # LivingEvent.LivingJumpEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEvent.LivingJumpEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/zombie_event/zombie_event.md: -------------------------------------------------------------------------------- 1 | # ZombieEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.ZombieEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.monster.EntityZombie getSummoner() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_event/living_update_event.md: -------------------------------------------------------------------------------- 1 | # LivingEvent.LivingUpdateEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEvent.LivingUpdateEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/portal_spawn_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.PortalSpawnEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.PortalSpawnEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.block.BlockPortal$Size getPortalSize() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_watch_event/chunk_watch_event.md: -------------------------------------------------------------------------------- 1 | # ChunkWatchEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkWatchEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.world.chunk.Chunk getChunkInstance() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayerMP getPlayer() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.ChunkPos getChunk() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/bloodmagic/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Blood Magic: Alchemical Wizardry 7 | 8 | ## Categories 9 | 10 | Has 7 subcategories. 11 | 12 | * [Alchemy Array](./alchemy_array.md) 13 | 14 | * [Alchemy Table](./alchemy_table.md) 15 | 16 | * [Blood Altar](./blood_altar.md) 17 | 18 | * [Meteor](./meteor.md) 19 | 20 | * [Sacrificial](./sacrificial.md) 21 | 22 | * [Tartaric Forge](./tartaric_forge.md) 23 | 24 | * [Tranquility](./tranquility.md) 25 | 26 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/enderio/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Ender IO](./index.md) 8 | * [Alloy Smelter](./alloy_smelter.md) 9 | * [Enchanter](./enchanter.md) 10 | * [Fluid Coolant](./fluid_coolant.md) 11 | * [Fluid Fuel](./fluid_fuel.md) 12 | * [Sag Mill](./sag_mill.md) 13 | * [Sag Mill Grinding](./sag_mill_grinding.md) 14 | * [Slice N Splice](./slice_n_splice.md) 15 | * [Soulbinder](./soul_binder.md) 16 | * [Tank](./tank.md) 17 | * [Vat](./vat.md) 18 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/item_toss_event.md: -------------------------------------------------------------------------------- 1 | # ItemTossEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.item.ItemTossEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ItemEvent](item_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayer getPlayer() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_event/create_spawn_position.md: -------------------------------------------------------------------------------- 1 | # WorldEvent.CreateSpawnPosition 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.WorldEvent.CreateSpawnPosition 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.world.WorldSettings getSettings() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/actuallyadditions/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Actually Additions](./index.md) 8 | * [Atomic Reconstructor](./atomic_reconstructor.md) 9 | * [Ball of Fur](./ball_of_fur.md) 10 | * [Compost](./compost.md) 11 | * [Crusher](./crusher.md) 12 | * [Empowerer](./empowerer.md) 13 | * [Nether Mining Lens](./nether_mining_lens.md) 14 | * [Oil Gen](./oil_gen.md) 15 | * [Stone Mining Lens](./stone_mining_lens.md) 16 | * [Treasure Chest](./treasure_chest.md) 17 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_data_event/chunk_data_event.md: -------------------------------------------------------------------------------- 1 | # ChunkDataEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ChunkDataEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkEvent](../chunk_event/chunk_event.md), [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.nbt.NBTTagCompound getData() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_death_event.md: -------------------------------------------------------------------------------- 1 | # LivingDeathEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingDeathEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.DamageSource getSource() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/minecart_update_event.md: -------------------------------------------------------------------------------- 1 | # MinecartUpdateEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.minecart.MinecartUpdateEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [MinecartEvent](minecart_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.math.BlockPos getPos() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_struck_by_lightning_event.md: -------------------------------------------------------------------------------- 1 | # EntityStruckByLightningEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityStruckByLightningEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.effect.EntityLightningBolt getLightning() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_event/potion_expiry_event.md: -------------------------------------------------------------------------------- 1 | # PotionEvent.PotionExpiryEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.PotionEvent.PotionExpiryEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PotionEvent](potion_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/projectile_impact_event/projectile_impact_event.md: -------------------------------------------------------------------------------- 1 | # ProjectileImpactEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.ProjectileImpactEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.math.RayTraceResult getRayTraceResult() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/thaumcraft/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Thaumcraft](./index.md) 8 | * [Arcane Workbench](./arcane_workbench.md) 9 | * [Aspect Creator](./aspect.md) 10 | * [Entity/Block Aspects](./aspect_helper.md) 11 | * [Crucible](./crucible.md) 12 | * [Dust Trigger](./dust_trigger.md) 13 | * [Infusion Crafting](./infusion_crafting.md) 14 | * [Lootbag](./loot_bag.md) 15 | * [Research](./research.md) 16 | * [Smelting Bonus](./smelting_bonus.md) 17 | * [Warp](./warp.md) 18 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_event/can_update.md: -------------------------------------------------------------------------------- 1 | # EntityEvent.CanUpdate 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityEvent.CanUpdate 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean getCanUpdate() 15 | ``` 16 | 17 | ```groovy 18 | void setCanUpdate(boolean arg0) 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/minecart_collision_event.md: -------------------------------------------------------------------------------- 1 | # MinecartCollisionEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.minecart.MinecartCollisionEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [MinecartEvent](minecart_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getCollider() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_event/potion_event.md: -------------------------------------------------------------------------------- 1 | # PotionEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.PotionEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.potion.PotionEffect getPotionEffect() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/item_expire_event.md: -------------------------------------------------------------------------------- 1 | # ItemExpireEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.item.ItemExpireEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ItemEvent](item_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getExtraLife() 15 | ``` 16 | 17 | ```groovy 18 | void setExtraLife(int arg0) 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/player_event.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayer getEntityPlayer() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/pyrotech/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Pyrotech](./index.md) 8 | * [Anvil](./anvil.md) 9 | * [Barrel](./barrel.md) 10 | * [Campfire](./campfire.md) 11 | * [Chopping Block](./chopping_block.md) 12 | * [Compacting Bin](./compacting_bin.md) 13 | * [Compost Bin](./compost_bin.md) 14 | * [Crude Drying Rack](./crude_drying_rack.md) 15 | * [Drying Rack](./drying_rack.md) 16 | * [Kiln](./kiln.md) 17 | * [Soaking Pot](./soaking_pot.md) 18 | * [Tanning Rack](./tanning_rack.md) 19 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/entity_multi_place_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.EntityMultiPlaceEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.EntityMultiPlaceEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityPlaceEvent](entity_place_event.md), [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.util.List getReplacedBlockSnapshots() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/explosion_event/detonate.md: -------------------------------------------------------------------------------- 1 | # ExplosionEvent.Detonate 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.ExplosionEvent.Detonate 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ExplosionEvent](explosion_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.util.List getAffectedBlocks() 15 | ``` 16 | 17 | ```groovy 18 | java.util.List getAffectedEntities() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_heal_event.md: -------------------------------------------------------------------------------- 1 | # LivingHealEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingHealEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setAmount(float arg0) 15 | ``` 16 | 17 | ```groovy 18 | float getAmount() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/multi_place_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.MultiPlaceEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.MultiPlaceEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlaceEvent](place_event.md), [EntityPlaceEvent](entity_place_event.md), [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.util.List getReplacedBlockSnapshots() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_entity_use_item_event/start.md: -------------------------------------------------------------------------------- 1 | # LivingEntityUseItemEvent.Start 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEntityUseItemEvent.Start 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEntityUseItemEvent](living_entity_use_item_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_entity_use_item_event/stop.md: -------------------------------------------------------------------------------- 1 | # LivingEntityUseItemEvent.Stop 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEntityUseItemEvent.Stop 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEntityUseItemEvent](living_entity_use_item_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_entity_use_item_event/tick.md: -------------------------------------------------------------------------------- 1 | # LivingEntityUseItemEvent.Tick 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEntityUseItemEvent.Tick 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEntityUseItemEvent](living_entity_use_item_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_set_attack_target_event.md: -------------------------------------------------------------------------------- 1 | # LivingSetAttackTargetEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingSetAttackTargetEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.EntityLivingBase getTarget() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/farmland_trample_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.FarmlandTrampleEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.FarmlandTrampleEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getEntity() 15 | ``` 16 | 17 | ```groovy 18 | float getFallDistance() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/neighbor_notify_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.NeighborNotifyEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.NeighborNotifyEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean getForceRedstoneUpdate() 15 | ``` 16 | 17 | ```groovy 18 | java.util.EnumSet getNotifiedSides() 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/projectile_impact_event/arrow.md: -------------------------------------------------------------------------------- 1 | # ProjectileImpactEvent.Arrow 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.ProjectileImpactEvent.Arrow 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ProjectileImpactEvent](projectile_impact_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.projectile.EntityArrow getArrow() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_attack_event.md: -------------------------------------------------------------------------------- 1 | # LivingAttackEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingAttackEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.DamageSource getSource() 15 | ``` 16 | 17 | ```groovy 18 | float getAmount() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_brewed_potion_event.md: -------------------------------------------------------------------------------- 1 | # PlayerBrewedPotionEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.brewing.PlayerBrewedPotionEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.item.ItemStack getStack() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_drops_event.md: -------------------------------------------------------------------------------- 1 | # PlayerDropsEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerDropsEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingDropsEvent](living_drops_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayer getEntityPlayer() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_pickup_xp_event.md: -------------------------------------------------------------------------------- 1 | # PlayerPickupXpEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerPickupXpEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.item.EntityXPOrb getOrb() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/advancement_event.md: -------------------------------------------------------------------------------- 1 | # AdvancementEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.AdvancementEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | 10 | This event extends the following events and can use all their methods and fields:
11 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 12 | 13 | ## Methods 14 | ```groovy 15 | net.minecraft.advancements.Advancement getAdvancement() 16 | ``` 17 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/attack_entity_event.md: -------------------------------------------------------------------------------- 1 | # AttackEntityEvent 2 | 3 | To use this event use the following import: 4 | 5 | ```groovy 6 | import net.minecraftforge.event.entity.player.AttackEntityEvent 7 | ``` 8 | 9 | ## Sub-Classes 10 | 11 | This event extends the following events and can use all their methods and fields:
12 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 13 | 14 | ## Methods 15 | 16 | ```groovy 17 | net.minecraft.entity.Entity getTarget() 18 | ``` 19 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_container_event/close.md: -------------------------------------------------------------------------------- 1 | # PlayerContainerEvent.Close 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerContainerEvent.Close 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerContainerEvent](player_container_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_container_event/open.md: -------------------------------------------------------------------------------- 1 | # PlayerContainerEvent.Open 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerContainerEvent.Open 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerContainerEvent](player_container_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/projectile_impact_event/fireball.md: -------------------------------------------------------------------------------- 1 | # ProjectileImpactEvent.Fireball 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.ProjectileImpactEvent.Fireball 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ProjectileImpactEvent](projectile_impact_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.projectile.EntityFireball getFireball() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/enderio/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Ender IO 7 | 8 | ## Categories 9 | 10 | Has 10 subcategories. 11 | 12 | * [Alloy Smelter](./alloy_smelter.md) 13 | 14 | * [Enchanter](./enchanter.md) 15 | 16 | * [Fluid Coolant](./fluid_coolant.md) 17 | 18 | * [Fluid Fuel](./fluid_fuel.md) 19 | 20 | * [Sag Mill](./sag_mill.md) 21 | 22 | * [Sag Mill Grinding](./sag_mill_grinding.md) 23 | 24 | * [Slice N Splice](./slice_n_splice.md) 25 | 26 | * [Soulbinder](./soul_binder.md) 27 | 28 | * [Tank](./tank.md) 29 | 30 | * [Vat](./vat.md) 31 | 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/biome_color.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent.BiomeColor 2 | 3 | To use this event use the following import: 4 | 5 | ```groovy 6 | import net.minecraftforge.event.terraingen.BiomeEvent.BiomeColor 7 | ``` 8 | 9 | ## Sub-Classes 10 | 11 | This event extends the following events and can use all their methods and fields:
12 | [BiomeEvent](biome_event.md) 13 | 14 | ## Methods 15 | 16 | ```groovy 17 | int getNewColor() 18 | ``` 19 | 20 | ```groovy 21 | int getOriginalColor() 22 | ``` 23 | 24 | ```groovy 25 | void setNewColor(int arg0) 26 | ``` 27 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_spawn_event/allow_despawn.md: -------------------------------------------------------------------------------- 1 | # LivingSpawnEvent.AllowDespawn 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingSpawnEvent.AllowDespawn 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingSpawnEvent](living_spawn_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/projectile_impact_event/throwable.md: -------------------------------------------------------------------------------- 1 | # ProjectileImpactEvent.Throwable 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.ProjectileImpactEvent.Throwable 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ProjectileImpactEvent](projectile_impact_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.projectile.EntityThrowable getThrowable() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_type_event/biome_size.md: -------------------------------------------------------------------------------- 1 | # WorldTypeEvent.BiomeSize 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.WorldTypeEvent.BiomeSize 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldTypeEvent](world_type_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getOriginalSize() 15 | ``` 16 | 17 | ```groovy 18 | void setNewSize(int arg0) 19 | ``` 20 | 21 | ```groovy 22 | int getNewSize() 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/break_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.BreakEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.BreakEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayer getPlayer() 15 | ``` 16 | 17 | ```groovy 18 | int getExpToDrop() 19 | ``` 20 | 21 | ```groovy 22 | void setExpToDrop(int arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/content/creative_tab.md: -------------------------------------------------------------------------------- 1 | # Creating creative tabs 2 | 3 | ```groovy 4 | content.createCreativeTab(String name, ItemStack icon) // returns the creative tab 5 | ``` 6 | 7 | !!! example 8 | 9 | ```groovy 10 | def creativeTab = content.createCreativeTab("nomifactory.creative_tab", item("nomifactory:heart_of_the_universe")) 11 | ``` 12 | 13 | ## Other 14 | 15 | You can get a creative tab by using 16 | 17 | ```groovy 18 | creativeTab(String tabName) 19 | ``` 20 | 21 | A list of existing creative tab names can be obtained by running the `/gs creativeTabs` command. 22 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/init_map_gen_event.md: -------------------------------------------------------------------------------- 1 | # InitMapGenEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.InitMapGenEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraftforge.event.terraingen.InitMapGenEvent$EventType getType() 11 | ``` 12 | 13 | ```groovy 14 | void setNewGen(net.minecraft.world.gen.MapGenBase arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.world.gen.MapGenBase getOriginalGen() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.world.gen.MapGenBase getNewGen() 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/start_tracking.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.StartTracking 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.StartTracking 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getTarget() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/stop_tracking.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.StopTracking 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.StopTracking 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getTarget() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/sapling_grow_tree_event.md: -------------------------------------------------------------------------------- 1 | # SaplingGrowTreeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.SaplingGrowTreeEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPos() 19 | ``` 20 | 21 | ```groovy 22 | java.util.Random getRand() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/actuallyadditions/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Actually Additions 7 | 8 | ## Categories 9 | 10 | Has 9 subcategories. 11 | 12 | * [Atomic Reconstructor](./atomic_reconstructor.md) 13 | 14 | * [Ball of Fur](./ball_of_fur.md) 15 | 16 | * [Compost](./compost.md) 17 | 18 | * [Crusher](./crusher.md) 19 | 20 | * [Empowerer](./empowerer.md) 21 | 22 | * [Nether Mining Lens](./nether_mining_lens.md) 23 | 24 | * [Oil Gen](./oil_gen.md) 25 | 26 | * [Stone Mining Lens](./stone_mining_lens.md) 27 | 28 | * [Treasure Chest](./treasure_chest.md) 29 | 30 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/loot_table_load_event.md: -------------------------------------------------------------------------------- 1 | # LootTableLoadEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.LootTableLoadEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.util.ResourceLocation getName() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.world.storage.loot.LootTable getTable() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.world.storage.loot.LootTableManager getLootTableManager() 19 | ``` 20 | 21 | ```groovy 22 | void setTable(net.minecraft.world.storage.loot.LootTable arg0) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/merchant_trade_offers_event.md: -------------------------------------------------------------------------------- 1 | # MerchantTradeOffersEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.village.MerchantTradeOffersEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.entity.player.EntityPlayer getPlayer() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.village.MerchantRecipeList getList() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.entity.IMerchant getMerchant() 19 | ``` 20 | 21 | ```groovy 22 | void setList(net.minecraft.village.MerchantRecipeList arg0) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/registry_event/register.md: -------------------------------------------------------------------------------- 1 | # RegistryEvent.Register 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.RegistryEvent.Register 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [RegistryEvent](registry_event.md), [GenericEvent](../generic_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.ResourceLocation getName() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.registries.IForgeRegistry getRegistry() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/throwable_impact_event.md: -------------------------------------------------------------------------------- 1 | # ThrowableImpactEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.ThrowableImpactEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.projectile.EntityThrowable getEntityThrowable() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.RayTraceResult getRayTraceResult() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/left_click_empty.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.LeftClickEmpty 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.LeftClickEmpty 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/right_click_item.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.RightClickItem 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.RightClickItem 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/right_click_empty.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.RightClickEmpty 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.RightClickEmpty 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/thaumcraft/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Thaumcraft 7 | 8 | ## Categories 9 | 10 | Has 10 subcategories. 11 | 12 | * [Arcane Workbench](./arcane_workbench.md) 13 | 14 | * [Aspect Creator](./aspect.md) 15 | 16 | * [Entity/Block Aspects](./aspect_helper.md) 17 | 18 | * [Crucible](./crucible.md) 19 | 20 | * [Dust Trigger](./dust_trigger.md) 21 | 22 | * [Infusion Crafting](./infusion_crafting.md) 23 | 24 | * [Lootbag](./loot_bag.md) 25 | 26 | * [Research](./research.md) 27 | 28 | * [Smelting Bonus](./smelting_bonus.md) 29 | 30 | * [Warp](./warp.md) 31 | 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/animal_tame_event.md: -------------------------------------------------------------------------------- 1 | # AnimalTameEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.AnimalTameEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | 10 | This event extends the following events and can use all their methods and fields:
11 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 12 | 13 | ## Methods 14 | ```groovy 15 | net.minecraft.entity.player.EntityPlayer getTamer() 16 | ``` 17 | ```groovy 18 | net.minecraft.entity.passive.EntityAnimal getAnimal() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_container_event/player_container_event.md: -------------------------------------------------------------------------------- 1 | # PlayerContainerEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerContainerEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.inventory.Container getContainer() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_spawn_event/special_spawn.md: -------------------------------------------------------------------------------- 1 | # LivingSpawnEvent.SpecialSpawn 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingSpawnEvent.SpecialSpawn 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingSpawnEvent](living_spawn_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.tileentity.MobSpawnerBaseLogic getSpawner() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_destroy_block_event.md: -------------------------------------------------------------------------------- 1 | # LivingDestroyBlockEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingDestroyBlockEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.block.state.IBlockState getState() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPos() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_pack_size_event.md: -------------------------------------------------------------------------------- 1 | # LivingPackSizeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingPackSizeEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | int getMaxPackSize() 19 | ``` 20 | 21 | ```groovy 22 | void setMaxPackSize(int arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/server_chat_event.md: -------------------------------------------------------------------------------- 1 | # ServerChatEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.ServerChatEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | java.lang.String getMessage() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.util.text.ITextComponent getComponent() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.entity.player.EntityPlayerMP getPlayer() 19 | ``` 20 | 21 | ```groovy 22 | void setComponent(net.minecraft.util.text.ITextComponent arg0) 23 | ``` 24 | 25 | ```groovy 26 | java.lang.String getUsername() 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_hurt_event.md: -------------------------------------------------------------------------------- 1 | # LivingHurtEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingHurtEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.DamageSource getSource() 15 | ``` 16 | 17 | ```groovy 18 | void setAmount(float arg0) 19 | ``` 20 | 21 | ```groovy 22 | float getAmount() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_set_spawn_event.md: -------------------------------------------------------------------------------- 1 | # PlayerSetSpawnEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerSetSpawnEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean isForced() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getNewSpawn() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/pyrotech/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Pyrotech 7 | 8 | ## Categories 9 | 10 | Has 11 subcategories. 11 | 12 | * [Anvil](./anvil.md) 13 | 14 | * [Barrel](./barrel.md) 15 | 16 | * [Campfire](./campfire.md) 17 | 18 | * [Chopping Block](./chopping_block.md) 19 | 20 | * [Compacting Bin](./compacting_bin.md) 21 | 22 | * [Compost Bin](./compost_bin.md) 23 | 24 | * [Crude Drying Rack](./crude_drying_rack.md) 25 | 26 | * [Drying Rack](./drying_rack.md) 27 | 28 | * [Kiln](./kiln.md) 29 | 30 | * [Soaking Pot](./soaking_pot.md) 31 | 32 | * [Tanning Rack](./tanning_rack.md) 33 | 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GroovyScript Docs 2 | 3 | This is the official repository for the GroovyScript Documentation using Read the Docs and MkDocs\ 4 | Docs are hosted [here](https://groovyscript-docs.readthedocs.io/en/latest/) 5 | 6 | ## Test locally 7 | 8 | Run the following from a terminal 9 | 10 | ```bash 11 | pip install -r requirements.txt 12 | 13 | mkdocs serve 14 | ``` 15 | 16 | `pip install` installs the required dependencies and `mkdocs serve` builds and runs the doc on a local server.\ 17 | After that simply open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in a browser. It automatically refreshes when you save files. 18 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/get_collision_boxes_event.md: -------------------------------------------------------------------------------- 1 | # GetCollisionBoxesEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.GetCollisionBoxesEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getEntity() 15 | ``` 16 | 17 | ```groovy 18 | java.util.List getCollisionBoxesList() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.math.AxisAlignedBB getAabb() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_damage_event.md: -------------------------------------------------------------------------------- 1 | # LivingDamageEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingDamageEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.DamageSource getSource() 15 | ``` 16 | 17 | ```groovy 18 | void setAmount(float arg0) 19 | ``` 20 | 21 | ```groovy 22 | float getAmount() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_event/potential_spawns.md: -------------------------------------------------------------------------------- 1 | # WorldEvent.PotentialSpawns 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.WorldEvent.PotentialSpawns 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](../world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.EnumCreatureType getType() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPos() 19 | ``` 20 | 21 | ```groovy 22 | java.util.List getList() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_item_pickup_event.md: -------------------------------------------------------------------------------- 1 | # EntityItemPickupEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.EntityItemPickupEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.item.EntityItem getItem() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasResult() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/clone.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.Clone 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.Clone 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayer getOriginal() 15 | ``` 16 | 17 | ```groovy 18 | boolean isWasDeath() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/village_siege_event.md: -------------------------------------------------------------------------------- 1 | # VillageSiegeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.village.VillageSiegeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.village.Village getVillage() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.village.VillageSiege getSiege() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.Vec3d getAttemptedSpawnPos() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.entity.player.EntityPlayer getPlayer() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.world.World getWorld() 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/note_block_event/change.md: -------------------------------------------------------------------------------- 1 | # NoteBlockEvent.Change 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.NoteBlockEvent.Change 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [NoteBlockEvent](note_block_event.md), [BlockEvent](../block_event/block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.world.NoteBlockEvent$Note getOldNote() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.event.world.NoteBlockEvent$Octave getOldOctave() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/visibility.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.Visibility 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.Visibility 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | double getVisibilityModifier() 15 | ``` 16 | 17 | ```groovy 18 | void modifyVisibility(double arg0) 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/looting_level_event.md: -------------------------------------------------------------------------------- 1 | # LootingLevelEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LootingLevelEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.DamageSource getDamageSource() 15 | ``` 16 | 17 | ```groovy 18 | void setLootingLevel(int arg0) 19 | ``` 20 | 21 | ```groovy 22 | int getLootingLevel() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/sleeping_time_check_event.md: -------------------------------------------------------------------------------- 1 | # SleepingTimeCheckEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.SleepingTimeCheckEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getSleepingLocation() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/botania/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Botania](./index.md) 8 | * [Petal Apothecary](./apothecary.md) 9 | * [Brew Effect](./brew.md) 10 | * [Brew Recipe](./brew_recipe.md) 11 | * [Elven Trade](./elven_trade.md) 12 | * [Magnet](./magnet.md) 13 | * [Mana Infusion](./mana_infusion.md) 14 | * [Orechid](./orechid.md) 15 | * [Orechid Ignem](./orechid_ignem.md) 16 | * [Pure Daisy](./pure_daisy.md) 17 | * [Rune Altar](./rune_altar.md) 18 | * [Lexicon Knowledge](./knowledge.md) 19 | * [Lexicon Category](./category.md) 20 | * [Lexicon Page](./page.md) 21 | * [Lexicon Entry](./entry.md) 22 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_destroy_item_event.md: -------------------------------------------------------------------------------- 1 | # PlayerDestroyItemEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerDestroyItemEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.EnumHand getHand() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.item.ItemStack getOriginal() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/note_block_event/play.md: -------------------------------------------------------------------------------- 1 | # NoteBlockEvent.Play 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.NoteBlockEvent.Play 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [NoteBlockEvent](note_block_event.md), [BlockEvent](../block_event/block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.world.NoteBlockEvent$Instrument getInstrument() 15 | ``` 16 | 17 | ```groovy 18 | void setInstrument(net.minecraftforge.event.world.NoteBlockEvent$Instrument arg0) 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/sleeping_location_check_event.md: -------------------------------------------------------------------------------- 1 | # SleepingLocationCheckEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.SleepingLocationCheckEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getSleepingLocation() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_wake_up_event.md: -------------------------------------------------------------------------------- 1 | # PlayerWakeUpEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerWakeUpEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean wakeImmediately() 15 | ``` 16 | 17 | ```groovy 18 | boolean shouldSetSpawn() 19 | ``` 20 | 21 | ```groovy 22 | boolean updateWorld() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/place_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.PlaceEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.PlaceEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityPlaceEvent](entity_place_event.md), [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.player.EntityPlayer getPlayer() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.EnumHand getHand() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.item.ItemStack getItemInHand() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/command_event.md: -------------------------------------------------------------------------------- 1 | # CommandEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.CommandEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | java.lang.Throwable getException() 11 | ``` 12 | 13 | ```groovy 14 | [Ljava.lang.String; getParameters() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.command.ICommand getCommand() 19 | ``` 20 | 21 | ```groovy 22 | void setParameters([Ljava.lang.String; arg0) 23 | ``` 24 | 25 | ```groovy 26 | void setException(java.lang.Throwable arg0) 27 | ``` 28 | 29 | ```groovy 30 | net.minecraft.command.ICommandSender getSender() 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_event/potion_applicable_event.md: -------------------------------------------------------------------------------- 1 | # PotionEvent.PotionApplicableEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.PotionEvent.PotionApplicableEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PotionEvent](potion_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.potion.PotionEffect getPotionEffect() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/entity_interact.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.EntityInteract 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.EntityInteract 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getTarget() 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/populate_chunk_event/populate.md: -------------------------------------------------------------------------------- 1 | # PopulateChunkEvent.Populate 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.PopulateChunkEvent.Populate 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PopulateChunkEvent](populate_chunk_event.md), [ChunkGeneratorEvent](../chunk_generator_event/chunk_generator_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.terraingen.PopulateChunkEvent$Populate$EventType getType() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasResult() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_spawn_event/living_spawn_event.md: -------------------------------------------------------------------------------- 1 | # LivingSpawnEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingSpawnEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | float getY() 15 | ``` 16 | 17 | ```groovy 18 | float getX() 19 | ``` 20 | 21 | ```groovy 22 | float getZ() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.world.World getWorld() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_event/potion_remove_event.md: -------------------------------------------------------------------------------- 1 | # PotionEvent.PotionRemoveEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.PotionEvent.PotionRemoveEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PotionEvent](potion_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.potion.Potion getPotion() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.potion.PotionEffect getPotionEffect() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/baby_entity_spawn_event.md: -------------------------------------------------------------------------------- 1 | # BabyEntitySpawnEvent 2 | 3 | To use this event use the following import: 4 | 5 | ```groovy 6 | import net.minecraftforge.event.entity.living.BabyEntitySpawnEvent 7 | ``` 8 | 9 | ## Methods 10 | 11 | ```groovy 12 | net.minecraft.entity.EntityLiving getParentB() 13 | ``` 14 | 15 | ```groovy 16 | net.minecraft.entity.EntityLiving getParentA() 17 | ``` 18 | 19 | ```groovy 20 | net.minecraft.entity.player.EntityPlayer getCausedByPlayer() 21 | ``` 22 | 23 | ```groovy 24 | void setChild(net.minecraft.entity.EntityAgeable arg0) 25 | ``` 26 | 27 | ```groovy 28 | net.minecraft.entity.EntityAgeable getChild() 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/init_noise_gens_event.md: -------------------------------------------------------------------------------- 1 | # InitNoiseGensEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.InitNoiseGensEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldEvent](world_event/world_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.terraingen.InitNoiseGensEvent$Context getNewValues() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.event.terraingen.InitNoiseGensEvent$Context getOriginal() 19 | ``` 20 | 21 | ```groovy 22 | java.util.Random getRandom() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/minecart_interact_event.md: -------------------------------------------------------------------------------- 1 | # MinecartInteractEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.minecart.MinecartInteractEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [MinecartEvent](minecart_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.item.ItemStack getItem() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.entity.player.EntityPlayer getPlayer() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.EnumHand getHand() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/attach_capabilities_event.md: -------------------------------------------------------------------------------- 1 | # AttachCapabilitiesEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.AttachCapabilitiesEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [GenericEvent](generic_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.lang.Object getObject() 15 | ``` 16 | 17 | ```groovy 18 | void addCapability(net.minecraft.util.ResourceLocation arg0, net.minecraftforge.common.capabilities.ICapabilityProvider arg1) 19 | ``` 20 | 21 | ```groovy 22 | java.util.Map getCapabilities() 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_entity_use_item_event/living_entity_use_item_event.md: -------------------------------------------------------------------------------- 1 | # LivingEntityUseItemEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEntityUseItemEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getDuration() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.item.ItemStack getItem() 19 | ``` 20 | 21 | ```groovy 22 | void setDuration(int arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_fall_event.md: -------------------------------------------------------------------------------- 1 | # LivingFallEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingFallEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | float getDamageMultiplier() 15 | ``` 16 | 17 | ```groovy 18 | void setDamageMultiplier(float arg0) 19 | ``` 20 | 21 | ```groovy 22 | void setDistance(float arg0) 23 | ``` 24 | 25 | ```groovy 26 | float getDistance() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/ore_gen_event/generate_minable.md: -------------------------------------------------------------------------------- 1 | # OreGenEvent.GenerateMinable 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.OreGenEvent.GenerateMinable 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [OreGenEvent](ore_gen_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.terraingen.OreGenEvent$GenerateMinable$EventType getType() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasResult() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.world.gen.feature.WorldGenerator getGenerator() 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_event/potion_added_event.md: -------------------------------------------------------------------------------- 1 | # PotionEvent.PotionAddedEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.PotionEvent.PotionAddedEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PotionEvent](potion_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.potion.PotionEffect getOldPotionEffect() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.potion.PotionEffect getPotionEffect() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/immersiveengineering/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Immersive Engineering](./index.md) 8 | * [Alloy Kiln](./alloy_kiln.md) 9 | * [Arc Furnace](./arc_furnace.md) 10 | * [Blast Furnace](./blast_furnace.md) 11 | * [Blast Furnace Fuel](./blast_furnace_fuel.md) 12 | * [Blueprint Crafting](./blueprint_crafting.md) 13 | * [Bottling Machine](./bottling_machine.md) 14 | * [Coke Oven](./coke_oven.md) 15 | * [Crusher](./crusher.md) 16 | * [Excavator](./excavator.md) 17 | * [Fermenter](./fermenter.md) 18 | * [Metal Press](./metal_press.md) 19 | * [Mixer](./mixer.md) 20 | * [Refinery](./refinery.md) 21 | * [Squeezer](./squeezer.md) 22 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/decorate_biome_event/decorate.md: -------------------------------------------------------------------------------- 1 | # DecorateBiomeEvent.Decorate 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.DecorateBiomeEvent.Decorate 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [DecorateBiomeEvent](decorate_biome_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.terraingen.DecorateBiomeEvent$Decorate$EventType getType() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPlacementPos() 19 | ``` 20 | 21 | ```groovy 22 | boolean hasResult() 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_drops_event.md: -------------------------------------------------------------------------------- 1 | # LivingDropsEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingDropsEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.DamageSource getSource() 15 | ``` 16 | 17 | ```groovy 18 | java.util.List getDrops() 19 | ``` 20 | 21 | ```groovy 22 | boolean isRecentlyHit() 23 | ``` 24 | 25 | ```groovy 26 | int getLootingLevel() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_equipment_change_event.md: -------------------------------------------------------------------------------- 1 | # LivingEquipmentChangeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEquipmentChangeEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.inventory.EntityEquipmentSlot getSlot() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.item.ItemStack getTo() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.item.ItemStack getFrom() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/create_decorator.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent.CreateDecorator 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.BiomeEvent.CreateDecorator 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BiomeEvent](biome_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.world.biome.BiomeDecorator getNewBiomeDecorator() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.world.biome.BiomeDecorator getOriginalBiomeDecorator() 19 | ``` 20 | 21 | ```groovy 22 | void setNewBiomeDecorator(net.minecraft.world.biome.BiomeDecorator arg0) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_entity_use_item_event/finish.md: -------------------------------------------------------------------------------- 1 | # LivingEntityUseItemEvent.Finish 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingEntityUseItemEvent.Finish 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEntityUseItemEvent](living_entity_use_item_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.item.ItemStack getResultStack() 15 | ``` 16 | 17 | ```groovy 18 | void setResultStack(net.minecraft.item.ItemStack arg0) 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_spawn_event/check_spawn.md: -------------------------------------------------------------------------------- 1 | # LivingSpawnEvent.CheckSpawn 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingSpawnEvent.CheckSpawn 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingSpawnEvent](living_spawn_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | boolean isSpawner() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.tileentity.MobSpawnerBaseLogic getSpawner() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/name_format.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.NameFormat 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.NameFormat 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.lang.String getUsername() 15 | ``` 16 | 17 | ```groovy 18 | java.lang.String getDisplayname() 19 | ``` 20 | 21 | ```groovy 22 | void setDisplayname(java.lang.String arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/harvest_check.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.HarvestCheck 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.HarvestCheck 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean canHarvest() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.block.state.IBlockState getTargetBlock() 19 | ``` 20 | 21 | ```groovy 22 | void setCanHarvest(boolean arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/save_to_file.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.SaveToFile 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.SaveToFile 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.io.File getPlayerDirectory() 15 | ``` 16 | 17 | ```groovy 18 | java.lang.String getPlayerUUID() 19 | ``` 20 | 21 | ```groovy 22 | java.io.File getPlayerFile(java.lang.String arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/load_from_file.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.LoadFromFile 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.LoadFromFile 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | java.io.File getPlayerDirectory() 15 | ``` 16 | 17 | ```groovy 18 | java.lang.String getPlayerUUID() 19 | ``` 20 | 21 | ```groovy 22 | java.io.File getPlayerFile(java.lang.String arg0) 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_flyable_fall_event.md: -------------------------------------------------------------------------------- 1 | # PlayerFlyableFallEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerFlyableFallEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | float getMultiplier() 15 | ``` 16 | 17 | ```groovy 18 | void setMultiplier(float arg0) 19 | ``` 20 | 21 | ```groovy 22 | void setDistance(float arg0) 23 | ``` 24 | 25 | ```groovy 26 | float getDistance() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/enchantment_level_set_event.md: -------------------------------------------------------------------------------- 1 | # EnchantmentLevelSetEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.enchanting.EnchantmentLevelSetEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | int getLevel() 11 | ``` 12 | 13 | ```groovy 14 | void setLevel(int arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.item.ItemStack getItem() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.math.BlockPos getPos() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.world.World getWorld() 27 | ``` 28 | 29 | ```groovy 30 | int getOriginalLevel() 31 | ``` 32 | 33 | ```groovy 34 | int getEnchantRow() 35 | ``` 36 | 37 | ```groovy 38 | int getPower() 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_mount_event.md: -------------------------------------------------------------------------------- 1 | # EntityMountEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityMountEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.world.World getWorldObj() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.entity.Entity getEntityBeingMounted() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.entity.Entity getEntityMounting() 23 | ``` 24 | 25 | ```groovy 26 | boolean isMounting() 27 | ``` 28 | 29 | ```groovy 30 | boolean isDismounting() 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/use_hoe_event.md: -------------------------------------------------------------------------------- 1 | # UseHoeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.UseHoeEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean hasResult() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPos() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.world.World getWorld() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.item.ItemStack getCurrent() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/ingredient.md: -------------------------------------------------------------------------------- 1 | # IIngredient 2 | In recipes, you often see `IIngredient` as input. The following things are `IIngredient`'s: 3 | 4 | - `ItemStack` (f.e. `item('minecraft:apple')`) 5 | - ore dict (f.e. `ore('ingotIron')`) 6 | - Or ingredient (f.e. `item('minecraft:apple') | item('minecraft:iron_ingot)`) 7 | - `FluidStack` (f.e. `fluid('water')`) 8 | - `GasStack` (f.e. `gas('oxygen')`) (Mekanism required) 9 | 10 | So any time you see `IIngredient` you can technically insert any of these. However, fluids and gases might not give the expected result. 11 | In crafting recipes they are turned into any item that contains that specific fluid liker buckets or tanks. 12 | In other recipes it might be turned into a bucket. 13 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/biome_event/get_village_block_i_d.md: -------------------------------------------------------------------------------- 1 | # BiomeEvent.GetVillageBlockID 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.BiomeEvent.GetVillageBlockID 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BiomeEvent](biome_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.block.state.IBlockState getReplacement() 15 | ``` 16 | 17 | ```groovy 18 | void setReplacement(net.minecraft.block.state.IBlockState arg0) 19 | ``` 20 | 21 | ```groovy 22 | boolean hasResult() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.block.state.IBlockState getOriginal() 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/botania/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Botania 7 | 8 | ## Categories 9 | 10 | Has 14 subcategories. 11 | 12 | * [Petal Apothecary](./apothecary.md) 13 | 14 | * [Brew Effect](./brew.md) 15 | 16 | * [Brew Recipe](./brew_recipe.md) 17 | 18 | * [Elven Trade](./elven_trade.md) 19 | 20 | * [Magnet](./magnet.md) 21 | 22 | * [Mana Infusion](./mana_infusion.md) 23 | 24 | * [Orechid](./orechid.md) 25 | 26 | * [Orechid Ignem](./orechid_ignem.md) 27 | 28 | * [Pure Daisy](./pure_daisy.md) 29 | 30 | * [Rune Altar](./rune_altar.md) 31 | 32 | * [Lexicon Knowledge](./knowledge.md) 33 | 34 | * [Lexicon Category](./category.md) 35 | 36 | * [Lexicon Page](./page.md) 37 | 38 | * [Lexicon Entry](./entry.md) 39 | 40 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_experience_drop_event.md: -------------------------------------------------------------------------------- 1 | # LivingExperienceDropEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingExperienceDropEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getDroppedExperience() 15 | ``` 16 | 17 | ```groovy 18 | void setDroppedExperience(int arg0) 19 | ``` 20 | 21 | ```groovy 22 | int getOriginalExperience() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.entity.player.EntityPlayer getAttackingPlayer() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/anvil_update_event.md: -------------------------------------------------------------------------------- 1 | # AnvilUpdateEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.AnvilUpdateEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | java.lang.String getName() 11 | ``` 12 | ```groovy 13 | net.minecraft.item.ItemStack getOutput() 14 | ``` 15 | ```groovy 16 | net.minecraft.item.ItemStack getRight() 17 | ``` 18 | ```groovy 19 | net.minecraft.item.ItemStack getLeft() 20 | ``` 21 | ```groovy 22 | void setOutput(net.minecraft.item.ItemStack arg0) 23 | ``` 24 | ```groovy 25 | void setCost(int arg0) 26 | ``` 27 | ```groovy 28 | void setMaterialCost(int arg0) 29 | ``` 30 | ```groovy 31 | int getCost() 32 | ``` 33 | ```groovy 34 | int getMaterialCost() 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/entity_place_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.EntityPlaceEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.EntityPlaceEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getEntity() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.common.util.BlockSnapshot getBlockSnapshot() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.block.state.IBlockState getPlacedBlock() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.block.state.IBlockState getPlacedAgainst() 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/item_fished_event.md: -------------------------------------------------------------------------------- 1 | # ItemFishedEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.ItemFishedEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getRodDamage() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.NonNullList getDrops() 19 | ``` 20 | 21 | ```groovy 22 | void damageRodBy(int arg0) 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.entity.projectile.EntityFishHook getHookEntity() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/entity_interact_specific.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.EntityInteractSpecific 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.EntityInteractSpecific 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getTarget() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.Vec3d getLocalPos() 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/world_type_event/init_biome_gens.md: -------------------------------------------------------------------------------- 1 | # WorldTypeEvent.InitBiomeGens 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.WorldTypeEvent.InitBiomeGens 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [WorldTypeEvent](world_type_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | long getSeed() 15 | ``` 16 | 17 | ```groovy 18 | void setNewBiomeGens([Lnet.minecraft.world.gen.layer.GenLayer; arg0) 19 | ``` 20 | 21 | ```groovy 22 | [Lnet.minecraft.world.gen.layer.GenLayer; getNewBiomeGens() 23 | ``` 24 | 25 | ```groovy 26 | [Lnet.minecraft.world.gen.layer.GenLayer; getOriginalBiomeGens() 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/fluid_place_block_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.FluidPlaceBlockEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.FluidPlaceBlockEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.block.state.IBlockState getNewState() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getLiquidPos() 19 | ``` 20 | 21 | ```groovy 22 | void setNewState(net.minecraft.block.state.IBlockState arg0) 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.block.state.IBlockState getOriginalState() 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/arrow_loose_event.md: -------------------------------------------------------------------------------- 1 | # ArrowLooseEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.ArrowLooseEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.world.World getWorld() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasAmmo() 19 | ``` 20 | 21 | ```groovy 22 | int getCharge() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.item.ItemStack getBow() 27 | ``` 28 | 29 | ```groovy 30 | void setCharge(int arg0) 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_color_calculation_event.md: -------------------------------------------------------------------------------- 1 | # PotionColorCalculationEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.PotionColorCalculationEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setColor(int arg0) 15 | ``` 16 | 17 | ```groovy 18 | void shouldHideParticles(boolean arg0) 19 | ``` 20 | 21 | ```groovy 22 | boolean areParticlesHidden() 23 | ``` 24 | 25 | ```groovy 26 | int getColor() 27 | ``` 28 | 29 | ```groovy 30 | java.util.Collection getEffects() 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_generator_event/replace_biome_blocks.md: -------------------------------------------------------------------------------- 1 | # ChunkGeneratorEvent.ReplaceBiomeBlocks 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.ChunkGeneratorEvent.ReplaceBiomeBlocks 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkGeneratorEvent](../chunk_generator_event/chunk_generator_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getX() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasResult() 19 | ``` 20 | 21 | ```groovy 22 | int getZ() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.world.World getWorld() 27 | ``` 28 | 29 | ```groovy 30 | net.minecraft.world.chunk.ChunkPrimer getPrimer() 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_sleep_in_bed_event.md: -------------------------------------------------------------------------------- 1 | # PlayerSleepInBedEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerSleepInBedEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setResult(net.minecraft.entity.player.EntityPlayer$SleepResult arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPos() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.entity.player.EntityPlayer$SleepResult getResultStatus() 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/immersiveengineering/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Immersive Engineering 7 | 8 | ## Categories 9 | 10 | Has 14 subcategories. 11 | 12 | * [Alloy Kiln](./alloy_kiln.md) 13 | 14 | * [Arc Furnace](./arc_furnace.md) 15 | 16 | * [Blast Furnace](./blast_furnace.md) 17 | 18 | * [Blast Furnace Fuel](./blast_furnace_fuel.md) 19 | 20 | * [Blueprint Crafting](./blueprint_crafting.md) 21 | 22 | * [Bottling Machine](./bottling_machine.md) 23 | 24 | * [Coke Oven](./coke_oven.md) 25 | 26 | * [Crusher](./crusher.md) 27 | 28 | * [Excavator](./excavator.md) 29 | 30 | * [Fermenter](./fermenter.md) 31 | 32 | * [Metal Press](./metal_press.md) 33 | 34 | * [Mixer](./mixer.md) 35 | 36 | * [Refinery](./refinery.md) 37 | 38 | * [Squeezer](./squeezer.md) 39 | 40 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/harvest_drops_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.HarvestDropsEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.HarvestDropsEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setDropChance(float arg0) 15 | ``` 16 | 17 | ```groovy 18 | java.util.List getDrops() 19 | ``` 20 | 21 | ```groovy 22 | float getDropChance() 23 | ``` 24 | 25 | ```groovy 26 | int getFortuneLevel() 27 | ``` 28 | 29 | ```groovy 30 | boolean isSilkTouching() 31 | ``` 32 | 33 | ```groovy 34 | net.minecraft.entity.player.EntityPlayer getHarvester() 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/item_tooltip_event.md: -------------------------------------------------------------------------------- 1 | # ItemTooltipEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.ItemTooltipEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.client.util.ITooltipFlag getFlags() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.entity.player.EntityPlayer getEntityPlayer() 19 | ``` 20 | 21 | ```groovy 22 | java.util.List getToolTip() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.item.ItemStack getItemStack() 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/note_block_event/note_block_event.md: -------------------------------------------------------------------------------- 1 | # NoteBlockEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.NoteBlockEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](../block_event/block_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.event.world.NoteBlockEvent$Note getNote() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.event.world.NoteBlockEvent$Octave getOctave() 19 | ``` 20 | 21 | ```groovy 22 | int getVanillaNoteId() 23 | ``` 24 | 25 | ```groovy 26 | void setNote(net.minecraftforge.event.world.NoteBlockEvent$Note arg0, net.minecraftforge.event.world.NoteBlockEvent$Octave arg1) 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/furnace.md: -------------------------------------------------------------------------------- 1 | # Minecraft Furnace 2 | 3 | ## Adding Recipes 4 | 5 | Unlike other recipe types, furnace smelting does not use a recipe builder. 6 | 7 | ```groovy 8 | furnace.add(IIngredient input, ItemStack output) // applies a default exp of 0.1 9 | furnace.add(IIngredient input, ItemStack output, float exp) 10 | ``` 11 | 12 | !!! example 13 | 14 | ```groovy 15 | // smelt 1 dirt to produce one cobblestone and 0.5 exp 16 | furnace.add(item('minecraft:dirt'), item('minecraft:cobblestone'), 0.5f) 17 | ``` 18 | 19 | ## Removing Recipes 20 | 21 | ```groovy 22 | furnace.removeByInput(ItemStack input) 23 | ``` 24 | 25 | !!! example 26 | 27 | ```groovy 28 | // removes all recipes that input iron ore 29 | furnace.removeByInput(item('minecraft:iron_ore')) 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_event/break_speed.md: -------------------------------------------------------------------------------- 1 | # PlayerEvent.BreakSpeed 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerEvent.BreakSpeed 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.block.state.IBlockState getState() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.math.BlockPos getPos() 19 | ``` 20 | 21 | ```groovy 22 | float getNewSpeed() 23 | ``` 24 | 25 | ```groovy 26 | void setNewSpeed(float arg0) 27 | ``` 28 | 29 | ```groovy 30 | float getOriginalSpeed() 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/astralsorcery/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Astral Sorcery](./index.md) 8 | * [Chalice Interaction](./chalice_interaction.md) 9 | * [Constellation](./constellation.md) 10 | * [Fountain](./fountain.md) 11 | * [Grindstone](./grindstone.md) 12 | * [Infusion Altar](./infusion_altar.md) 13 | * [Light Transmutation](./light_transmutation.md) 14 | * [Lightwell](./lightwell.md) 15 | * [Perk Tree](./perk_tree.md) 16 | * [Perk Tree Config](./perk_tree_config.md) 17 | * [Research Pages](./research.md) 18 | * [Starlight Altar](./starlight_altar.md) 19 | * [Aevitas Perk Registry](./aevitas_perk_registry.md) 20 | * [Mineralis Ritual Registry](./mineralis_ritual_registry.md) 21 | * [Trash Perk Registry](./trash_perk_registry.md) 22 | * [Treasure Shrine Registry](./treasure_shrine_registry.md) 23 | -------------------------------------------------------------------------------- /docs/groovy/strings.md: -------------------------------------------------------------------------------- 1 | # Strings 2 | Strings are a sequence of characters. 3 | There are multiple ways to define a string and each does something different. 4 | The most simple way is by using `''`. In java these are used for chars. Here they create strings and don't do anything special. 5 | A more advanced way is by using `""`. They allow you to use variables inside the literal. 6 | The last way is by using `\\`. This is perfect for regex, because you don't need to escape any `\`. 7 | ```groovy 8 | def s = 'hello' // String 9 | def s2 = "hello" // can use either '' or "" 10 | assert s == s2 // both strings are equal 11 | 12 | def num = 7 13 | def numberOfDays = 'There are ' + num + ' days in a week' // using a variable inside the string with concatenation 14 | def numberOfDays2 = "There are $num days in a week" // using a variable inside the string with $ 15 | ``` -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/critical_hit_event.md: -------------------------------------------------------------------------------- 1 | # CriticalHitEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.CriticalHitEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getTarget() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasResult() 19 | ``` 20 | 21 | ```groovy 22 | float getDamageModifier() 23 | ``` 24 | 25 | ```groovy 26 | void setDamageModifier(float arg0) 27 | ``` 28 | 29 | ```groovy 30 | float getOldDamageModifier() 31 | ``` 32 | 33 | ```groovy 34 | boolean isVanillaCritical() 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/roots/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Roots 3](./index.md) 8 | * [Animal Harvest](./animal_harvest.md) 9 | * [Animal Harvest Fish](./animal_harvest_fish.md) 10 | * [Bark Carving](./bark_carving.md) 11 | * [Chrysopoeia](./chrysopoeia.md) 12 | * [Fey Crafter](./fey_crafter.md) 13 | * [Flower Generation](./flower_generation.md) 14 | * [Life Essence](./life_essence.md) 15 | * [Modifiers](./modifiers.md) 16 | * [Mortar And Pestle](./mortar.md) 17 | * [Moss](./moss.md) 18 | * [Pacifist](./pacifist.md) 19 | * [Predicates](./predicates.md) 20 | * [Pyre](./pyre.md) 21 | * [Rituals](./rituals.md) 22 | * [Runic Shear Block](./runic_shear_block.md) 23 | * [Runic Shear Entity](./runic_shear_entity.md) 24 | * [Spells](./spells.md) 25 | * [Summon Creature](./summon_creature.md) 26 | * [Transmutation](./transmutation.md) 27 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/entity_event/entering_chunk.md: -------------------------------------------------------------------------------- 1 | # EntityEvent.EnteringChunk 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.EntityEvent.EnteringChunk 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setNewChunkX(int arg0) 15 | ``` 16 | 17 | ```groovy 18 | void setNewChunkZ(int arg0) 19 | ``` 20 | 21 | ```groovy 22 | void setOldChunkX(int arg0) 23 | ``` 24 | 25 | ```groovy 26 | void setOldChunkZ(int arg0) 27 | ``` 28 | 29 | ```groovy 30 | int getNewChunkX() 31 | ``` 32 | 33 | ```groovy 34 | int getOldChunkX() 35 | ``` 36 | 37 | ```groovy 38 | int getOldChunkZ() 39 | ``` 40 | 41 | ```groovy 42 | int getNewChunkZ() 43 | ``` 44 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/bonemeal_event.md: -------------------------------------------------------------------------------- 1 | # BonemealEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.BonemealEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.item.ItemStack getStack() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.block.state.IBlockState getBlock() 19 | ``` 20 | 21 | ```groovy 22 | boolean hasResult() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.util.EnumHand getHand() 27 | ``` 28 | 29 | ```groovy 30 | net.minecraft.util.math.BlockPos getPos() 31 | ``` 32 | 33 | ```groovy 34 | net.minecraft.world.World getWorld() 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/registry_event/missing_mappings.md: -------------------------------------------------------------------------------- 1 | # RegistryEvent.MissingMappings 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.RegistryEvent.MissingMappings 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [RegistryEvent](registry_event.md), [GenericEvent](../generic_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.ResourceLocation getName() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.registries.IForgeRegistry getRegistry() 19 | ``` 20 | 21 | ```groovy 22 | void setModContainer(net.minecraftforge.fml.common.ModContainer arg0) 23 | ``` 24 | 25 | ```groovy 26 | com.google.common.collect.ImmutableList getAllMappings() 27 | ``` 28 | 29 | ```groovy 30 | com.google.common.collect.ImmutableList getMappings() 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/ender_teleport_event.md: -------------------------------------------------------------------------------- 1 | # EnderTeleportEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.EnderTeleportEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | double getTargetX() 15 | ``` 16 | 17 | ```groovy 18 | double getTargetY() 19 | ``` 20 | 21 | ```groovy 22 | double getTargetZ() 23 | ``` 24 | 25 | ```groovy 26 | float getAttackDamage() 27 | ``` 28 | 29 | ```groovy 30 | void setAttackDamage(float arg0) 31 | ``` 32 | 33 | ```groovy 34 | void setTargetX(double arg0) 35 | ``` 36 | 37 | ```groovy 38 | void setTargetZ(double arg0) 39 | ``` 40 | 41 | ```groovy 42 | void setTargetY(double arg0) 43 | ``` 44 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/arrow_nock_event.md: -------------------------------------------------------------------------------- 1 | # ArrowNockEvent 2 | 3 | To use this event use the following import: 4 | 5 | ```groovy 6 | import net.minecraftforge.event.entity.player.ArrowNockEvent 7 | ``` 8 | 9 | ## Sub-Classes 10 | 11 | This event extends the following events and can use all their methods and fields:
12 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 13 | 14 | ## Methods 15 | 16 | ```groovy 17 | net.minecraft.util.EnumHand getHand() 18 | ``` 19 | 20 | ```groovy 21 | net.minecraft.world.World getWorld() 22 | ``` 23 | 24 | ```groovy 25 | boolean hasAmmo() 26 | ``` 27 | 28 | ```groovy 29 | void setAction(net.minecraft.util.ActionResult arg0) 30 | ``` 31 | 32 | ```groovy 33 | net.minecraft.item.ItemStack getBow() 34 | ``` 35 | 36 | ```groovy 37 | net.minecraft.util.ActionResult getAction() 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/chunk_generator_event/init_noise_field.md: -------------------------------------------------------------------------------- 1 | # ChunkGeneratorEvent.InitNoiseField 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.ChunkGeneratorEvent.InitNoiseField 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkGeneratorEvent](../chunk_generator_event/chunk_generator_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getPosZ() 15 | ``` 16 | 17 | ```groovy 18 | [D getNoisefield() 19 | ``` 20 | 21 | ```groovy 22 | void setNoisefield([D arg0) 23 | ``` 24 | 25 | ```groovy 26 | int getSizeX() 27 | ``` 28 | 29 | ```groovy 30 | int getSizeZ() 31 | ``` 32 | 33 | ```groovy 34 | int getSizeY() 35 | ``` 36 | 37 | ```groovy 38 | boolean hasResult() 39 | ``` 40 | 41 | ```groovy 42 | int getPosY() 43 | ``` 44 | 45 | ```groovy 46 | int getPosX() 47 | ``` 48 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/fill_bucket_event.md: -------------------------------------------------------------------------------- 1 | # FillBucketEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.FillBucketEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.util.math.RayTraceResult getTarget() 15 | ``` 16 | 17 | ```groovy 18 | boolean hasResult() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.world.World getWorld() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.item.ItemStack getFilledBucket() 27 | ``` 28 | 29 | ```groovy 30 | void setFilledBucket(net.minecraft.item.ItemStack arg0) 31 | ``` 32 | 33 | ```groovy 34 | net.minecraft.item.ItemStack getEmptyBucket() 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/astralsorcery/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Astral Sorcery 7 | 8 | ## Categories 9 | 10 | Has 15 subcategories. 11 | 12 | * [Chalice Interaction](./chalice_interaction.md) 13 | 14 | * [Constellation](./constellation.md) 15 | 16 | * [Fountain](./fountain.md) 17 | 18 | * [Grindstone](./grindstone.md) 19 | 20 | * [Infusion Altar](./infusion_altar.md) 21 | 22 | * [Light Transmutation](./light_transmutation.md) 23 | 24 | * [Lightwell](./lightwell.md) 25 | 26 | * [Perk Tree](./perk_tree.md) 27 | 28 | * [Perk Tree Config](./perk_tree_config.md) 29 | 30 | * [Research Pages](./research.md) 31 | 32 | * [Starlight Altar](./starlight_altar.md) 33 | 34 | * [Aevitas Perk Registry](./aevitas_perk_registry.md) 35 | 36 | * [Mineralis Ritual Registry](./mineralis_ritual_registry.md) 37 | 38 | * [Trash Perk Registry](./trash_perk_registry.md) 39 | 40 | * [Treasure Shrine Registry](./treasure_shrine_registry.md) 41 | 42 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/jei/jei.md: -------------------------------------------------------------------------------- 1 | # Just Enough Items 2 | 3 | !!! Note 4 | Requires GroovyScript 0.3.1+ 5 | 6 | In all methods you can replace `jei` with `hei`. 7 | 8 | ## Hiding 9 | 10 | ```groovy 11 | mods.jei.hide(IIngredient) 12 | ``` 13 | 14 | ## Remove and Hiding 15 | 16 | ```groovy 17 | mods.jei.removeAndHide(IIngredient) 18 | // is exactly the same but with a cooler name 19 | mods.jei.yeet(IIngredient) 20 | ``` 21 | 22 | ## Hiding categories 23 | 24 | A list of categories can be obtained by running /gs jeiCategories in game. 25 | 26 | ```groovy 27 | mods.jei.hideCategory(String) 28 | ``` 29 | 30 | !!! example "Examples" 31 | 32 | ```groovy 33 | // hides nether star in jei 34 | mods.jei.hide(item('minecraft:nether_star')) 35 | 36 | // hides and removes all iron ingots and its crafting recipes 37 | mods.jei.removeAndHide(ore('ingotIron')) 38 | 39 | // hides all smelting recipes 40 | mods.jei.hideCategory('minecraft.smelting') 41 | ``` 42 | -------------------------------------------------------------------------------- /overrides/.icons/custom/curseforge.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/roots/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Roots 3 7 | 8 | ## Categories 9 | 10 | Has 19 subcategories. 11 | 12 | * [Animal Harvest](./animal_harvest.md) 13 | 14 | * [Animal Harvest Fish](./animal_harvest_fish.md) 15 | 16 | * [Bark Carving](./bark_carving.md) 17 | 18 | * [Chrysopoeia](./chrysopoeia.md) 19 | 20 | * [Fey Crafter](./fey_crafter.md) 21 | 22 | * [Flower Generation](./flower_generation.md) 23 | 24 | * [Life Essence](./life_essence.md) 25 | 26 | * [Modifiers](./modifiers.md) 27 | 28 | * [Mortar And Pestle](./mortar.md) 29 | 30 | * [Moss](./moss.md) 31 | 32 | * [Pacifist](./pacifist.md) 33 | 34 | * [Predicates](./predicates.md) 35 | 36 | * [Pyre](./pyre.md) 37 | 38 | * [Rituals](./rituals.md) 39 | 40 | * [Runic Shear Block](./runic_shear_block.md) 41 | 42 | * [Runic Shear Entity](./runic_shear_entity.md) 43 | 44 | * [Spells](./spells.md) 45 | 46 | * [Summon Creature](./summon_creature.md) 47 | 48 | * [Transmutation](./transmutation.md) 49 | 50 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/mekanism/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | 7 | * [Mekanism](./index.md) 8 | * [Infusion](./infusion.md) 9 | * [Chemical Infuser](./chemical_infuser.md) 10 | * [Chemical Oxidizer](./chemical_oxidizer.md) 11 | * [Combiner](./combiner.md) 12 | * [Crusher](./crusher.md) 13 | * [Crystallizer](./crystallizer.md) 14 | * [Dissolution Chamber](./dissolution_chamber.md) 15 | * [Electrolytic Separator](./electrolytic_separator.md) 16 | * [Enrichment Chamber](./enrichment_chamber.md) 17 | * [Injection Chamber](./injection_chamber.md) 18 | * [Metallurgic Infuser](./metallurgic_infuser.md) 19 | * [Osmium Compressor](./osmium_compressor.md) 20 | * [Pressurized Reaction Chamber](./pressurized_reaction_chamber.md) 21 | * [Purification Chamber](./purification_chamber.md) 22 | * [Sawmill](./sawmill.md) 23 | * [Smelting](./smelting.md) 24 | * [Solar Neutron Activator](./solar_neutron_activator.md) 25 | * [Thermal Evaporation Plant](./thermal_evaporation_plant.md) 26 | * [Washer](./washer.md) 27 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/anvil_repair_event.md: -------------------------------------------------------------------------------- 1 | # AnvilRepairEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.AnvilRepairEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | 10 | This event extends the following events and can use all their methods and fields:
11 | [PlayerEvent](player_event/player_event.md), [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 12 | 13 | ## Methods 14 | ```groovy 15 | net.minecraft.item.ItemStack getOutput() 16 | ``` 17 | ```groovy 18 | net.minecraft.item.ItemStack getRight() 19 | ``` 20 | ```groovy 21 | net.minecraft.item.ItemStack getLeft() 22 | ``` 23 | ```groovy 24 | net.minecraft.item.ItemStack getItemResult() 25 | ``` 26 | ```groovy 27 | void setBreakChance(float arg0) 28 | ``` 29 | ```groovy 30 | net.minecraft.item.ItemStack getItemInput() 31 | ``` 32 | ```groovy 33 | net.minecraft.item.ItemStack getIngredientInput() 34 | ``` 35 | ```groovy 36 | float getBreakChance() 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/zombie_event/summon_aid_event.md: -------------------------------------------------------------------------------- 1 | # ZombieEvent.SummonAidEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.ZombieEvent.SummonAidEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ZombieEvent](zombie_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | int getY() 15 | ``` 16 | 17 | ```groovy 18 | int getX() 19 | ``` 20 | 21 | ```groovy 22 | boolean hasResult() 23 | ``` 24 | 25 | ```groovy 26 | void setCustomSummonedAid(net.minecraft.entity.monster.EntityZombie arg0) 27 | ``` 28 | 29 | ```groovy 30 | net.minecraft.entity.monster.EntityZombie getCustomSummonedAid() 31 | ``` 32 | 33 | ```groovy 34 | int getZ() 35 | ``` 36 | 37 | ```groovy 38 | net.minecraft.world.World getWorld() 39 | ``` 40 | 41 | ```groovy 42 | double getSummonChance() 43 | ``` 44 | 45 | ```groovy 46 | net.minecraft.entity.EntityLivingBase getAttacker() 47 | ``` 48 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/play_sound_at_entity_event.md: -------------------------------------------------------------------------------- 1 | # PlaySoundAtEntityEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.PlaySoundAtEntityEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setCategory(net.minecraft.util.SoundCategory arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.SoundCategory getCategory() 19 | ``` 20 | 21 | ```groovy 22 | float getVolume() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.util.SoundEvent getSound() 27 | ``` 28 | 29 | ```groovy 30 | float getPitch() 31 | ``` 32 | 33 | ```groovy 34 | void setPitch(float arg0) 35 | ``` 36 | 37 | ```groovy 38 | void setVolume(float arg0) 39 | ``` 40 | 41 | ```groovy 42 | float getDefaultPitch() 43 | ``` 44 | 45 | ```groovy 46 | void setSound(net.minecraft.util.SoundEvent arg0) 47 | ``` 48 | 49 | ```groovy 50 | float getDefaultVolume() 51 | ``` 52 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/!navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | * [Actually Additions](./actuallyadditions/) 7 | * [Advanced Mortars](./advancedmortars/) 8 | * [Applied Energistics 2](./appliedenergistics2/) 9 | * [Astral Sorcery](./astralsorcery/) 10 | * [Avaritia](./avaritia/) 11 | * [Blood Magic: Alchemical Wizardry](./bloodmagic/) 12 | * [Botania](./botania/) 13 | * [Chisel](./chisel/) 14 | * [Compact Machines 3](./compactmachines3/) 15 | * [Draconic Evolution](./draconicevolution/) 16 | * [EnderIO](./enderio/) 17 | * [EvilCraft](./evilcraft/) 18 | * [Extended Crafting](./extendedcrafting/) 19 | * [Forestry](./forestry/forestry.md) 20 | * [GregTech](./gtceu/) 21 | * [Harken Scythe: Resharpened](./harkenscythe/) 22 | * [Immersive Engineering](./immersiveengineering/) 23 | * [Inspirations](./inspirations/) 24 | * [Integrated Dynamics](./integrateddynamics/) 25 | * [JEI](./jei/) 26 | * [Mekanism](./mekanism/) 27 | * [Pyrotech](./pyrotech/) 28 | * [Roots](./roots/) 29 | * [Thaumcraft](./thaumcraft/) 30 | * [Thermal Expansion](./thermal/) 31 | * [Woot](./woot/) 32 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/ore_gen_event/ore_gen_event.md: -------------------------------------------------------------------------------- 1 | # OreGenEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.OreGenEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.util.math.BlockPos getPos() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.world.World getWorld() 15 | ``` 16 | 17 | ```groovy 18 | java.util.Random getRand() 19 | ``` 20 | 21 | # OreGenEvent.Pre 22 | 23 | To use this event use the following import: 24 | ```groovy 25 | import net.minecraftforge.event.terraingen.OreGenEvent.Pre 26 | ``` 27 | 28 | ## Sub-Classes 29 | This event extends the following events and can use all their methods and fields:
30 | [OreGenEvent](ore_gen_event.md) 31 | 32 | ## Methods 33 | # OreGenEvent.Post 34 | 35 | To use this event use the following import: 36 | ```groovy 37 | import net.minecraftforge.event.terraingen.OreGenEvent.Post 38 | ``` 39 | 40 | ## Sub-Classes 41 | This event extends the following events and can use all their methods and fields:
42 | [OreGenEvent](ore_gen_event.md) 43 | 44 | ## Methods 45 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/potion_brew_event.md: -------------------------------------------------------------------------------- 1 | # PotionBrewEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.brewing.PotionBrewEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | int getLength() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.item.ItemStack getItem(int arg0) 15 | ``` 16 | 17 | ```groovy 18 | void setItem(int arg0, net.minecraft.item.ItemStack arg1) 19 | ``` 20 | 21 | # PotionBrewEvent.Pre 22 | 23 | To use this event use the following import: 24 | ```groovy 25 | import net.minecraftforge.event.brewing.PotionBrewEvent.Pre 26 | ``` 27 | 28 | ## Sub-Classes 29 | This event extends the following events and can use all their methods and fields:
30 | [PotionBrewEvent](potion_brew_event.md) 31 | 32 | ## Methods 33 | # PotionBrewEvent.Post 34 | 35 | To use this event use the following import: 36 | ```groovy 37 | import net.minecraftforge.event.brewing.PotionBrewEvent.Post 38 | ``` 39 | 40 | ## Sub-Classes 41 | This event extends the following events and can use all their methods and fields:
42 | [PotionBrewEvent](potion_brew_event.md) 43 | 44 | ## Methods 45 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/left_click_block.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.LeftClickBlock 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.LeftClickBlock 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setCanceled(boolean arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.fml.common.eventhandler.Event$Result getUseItem() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.math.Vec3d getHitVec() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraftforge.fml.common.eventhandler.Event$Result getUseBlock() 27 | ``` 28 | 29 | ```groovy 30 | void setUseBlock(net.minecraftforge.fml.common.eventhandler.Event$Result arg0) 31 | ``` 32 | 33 | ```groovy 34 | void setUseItem(net.minecraftforge.fml.common.eventhandler.Event$Result arg0) 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/right_click_block.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent.RightClickBlock 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent.RightClickBlock 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerInteractEvent](player_interact_event.md), [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | void setCanceled(boolean arg0) 15 | ``` 16 | 17 | ```groovy 18 | net.minecraftforge.fml.common.eventhandler.Event$Result getUseItem() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.math.Vec3d getHitVec() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraftforge.fml.common.eventhandler.Event$Result getUseBlock() 27 | ``` 28 | 29 | ```groovy 30 | void setUseBlock(net.minecraftforge.fml.common.eventhandler.Event$Result arg0) 31 | ``` 32 | 33 | ```groovy 34 | void setUseItem(net.minecraftforge.fml.common.eventhandler.Event$Result arg0) 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/mekanism/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | hide: toc 3 | --- 4 | 5 | 6 | # Mekanism 7 | 8 | ## Categories 9 | 10 | Has 19 subcategories. 11 | 12 | * [Infusion](./infusion.md) 13 | 14 | * [Chemical Infuser](./chemical_infuser.md) 15 | 16 | * [Chemical Oxidizer](./chemical_oxidizer.md) 17 | 18 | * [Combiner](./combiner.md) 19 | 20 | * [Crusher](./crusher.md) 21 | 22 | * [Crystallizer](./crystallizer.md) 23 | 24 | * [Dissolution Chamber](./dissolution_chamber.md) 25 | 26 | * [Electrolytic Separator](./electrolytic_separator.md) 27 | 28 | * [Enrichment Chamber](./enrichment_chamber.md) 29 | 30 | * [Injection Chamber](./injection_chamber.md) 31 | 32 | * [Metallurgic Infuser](./metallurgic_infuser.md) 33 | 34 | * [Osmium Compressor](./osmium_compressor.md) 35 | 36 | * [Pressurized Reaction Chamber](./pressurized_reaction_chamber.md) 37 | 38 | * [Purification Chamber](./purification_chamber.md) 39 | 40 | * [Sawmill](./sawmill.md) 41 | 42 | * [Smelting](./smelting.md) 43 | 44 | * [Solar Neutron Activator](./solar_neutron_activator.md) 45 | 46 | * [Thermal Evaporation Plant](./thermal_evaporation_plant.md) 47 | 48 | * [Washer](./washer.md) 49 | 50 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/player_interact_event/player_interact_event.md: -------------------------------------------------------------------------------- 1 | # PlayerInteractEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.player.PlayerInteractEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [PlayerEvent](../player_event/player_event.md), [LivingEvent](../living_event/living_event.md), [EntityEvent](../entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraftforge.fml.relauncher.Side getSide() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.util.EnumHand getHand() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.math.BlockPos getPos() 23 | ``` 24 | 25 | ```groovy 26 | net.minecraft.world.World getWorld() 27 | ``` 28 | 29 | ```groovy 30 | net.minecraft.util.EnumActionResult getCancellationResult() 31 | ``` 32 | 33 | ```groovy 34 | void setCancellationResult(net.minecraft.util.EnumActionResult arg0) 35 | ``` 36 | 37 | ```groovy 38 | net.minecraft.item.ItemStack getItemStack() 39 | ``` 40 | 41 | ```groovy 42 | net.minecraft.util.EnumFacing getFace() 43 | ``` 44 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/living_knock_back_event.md: -------------------------------------------------------------------------------- 1 | # LivingKnockBackEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.entity.living.LivingKnockBackEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [LivingEvent](living_event/living_event.md), [EntityEvent](entity_event/entity_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | net.minecraft.entity.Entity getOriginalAttacker() 15 | ``` 16 | 17 | ```groovy 18 | double getOriginalRatioX() 19 | ``` 20 | 21 | ```groovy 22 | double getOriginalRatioZ() 23 | ``` 24 | 25 | ```groovy 26 | float getOriginalStrength() 27 | ``` 28 | 29 | ```groovy 30 | net.minecraft.entity.Entity getAttacker() 31 | ``` 32 | 33 | ```groovy 34 | float getStrength() 35 | ``` 36 | 37 | ```groovy 38 | double getRatioX() 39 | ``` 40 | 41 | ```groovy 42 | double getRatioZ() 43 | ``` 44 | 45 | ```groovy 46 | void setStrength(float arg0) 47 | ``` 48 | 49 | ```groovy 50 | void setAttacker(net.minecraft.entity.Entity arg0) 51 | ``` 52 | 53 | ```groovy 54 | void setRatioZ(double arg0) 55 | ``` 56 | 57 | ```groovy 58 | void setRatioX(double arg0) 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/decorate_biome_event/decorate_biome_event.md: -------------------------------------------------------------------------------- 1 | # DecorateBiomeEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.DecorateBiomeEvent 6 | ``` 7 | 8 | ## Methods 9 | ```groovy 10 | net.minecraft.util.math.BlockPos getPos() 11 | ``` 12 | 13 | ```groovy 14 | net.minecraft.world.World getWorld() 15 | ``` 16 | 17 | ```groovy 18 | java.util.Random getRand() 19 | ``` 20 | 21 | ```groovy 22 | net.minecraft.util.math.ChunkPos getChunkPos() 23 | ``` 24 | 25 | # DecorateBiomeEvent.Pre 26 | 27 | To use this event use the following import: 28 | ```groovy 29 | import net.minecraftforge.event.terraingen.DecorateBiomeEvent.Pre 30 | ``` 31 | 32 | ## Sub-Classes 33 | This event extends the following events and can use all their methods and fields:
34 | [DecorateBiomeEvent](decorate_biome_event.md) 35 | 36 | ## Methods 37 | # DecorateBiomeEvent.Post 38 | 39 | To use this event use the following import: 40 | ```groovy 41 | import net.minecraftforge.event.terraingen.DecorateBiomeEvent.Post 42 | ``` 43 | 44 | ## Sub-Classes 45 | This event extends the following events and can use all their methods and fields:
46 | [DecorateBiomeEvent](decorate_biome_event.md) 47 | 48 | ## Methods 49 | -------------------------------------------------------------------------------- /docs/groovy/closure.md: -------------------------------------------------------------------------------- 1 | # Closures 2 | 3 | Closures are like lambdas in java, but slightly different. 4 | 5 | # For beginners 6 | 7 | You may know what a method is. A method is a set order of instructions you can call. For example: 8 | ```groovy 9 | def print_numbers(int n) { 10 | for (def i : 0..n) { 11 | log.info(i) 12 | } 13 | } 14 | ``` 15 | 16 | This method prints numbers from 0 to a given number to the log. 17 | ```groovy 18 | print_numbers(5) 19 | ``` 20 | 21 | This will now output 22 | 23 | ``` 24 | 0 25 | 1 26 | 2 27 | 3 28 | 4 29 | ``` 30 | 31 | You can call that method as often as you want with any number input. 32 | 33 | Now closures are methods, but you can carry them around. Example: 34 | ```groovy 35 | def print_numbers = { int n -> /*(1)!*/ 36 | for (def i : 0..n) { 37 | log.info(i) 38 | } 39 | } 40 | ``` 41 | 42 | 1. Most of the time the type is optional, so here it would become `{ n -> ...` 43 | 44 | This closure does the same thing as the method above, but it's a variable instead of a method. Just like any other 45 | variable you can pass it to other methods. (See [Events](../groovyscript/minecraft/events/index.md)). 46 | You can invoke this closure the same way you do with a method: 47 | 48 | ```groovy 49 | print_numbers(3) 50 | ``` 51 | -------------------------------------------------------------------------------- /docs/groovyscript/content/content.md: -------------------------------------------------------------------------------- 1 | # Content 2 | 3 | This part of GroovyScript allows the creation of game content like items and blocks. It's equivalent to ContentTweaker 4 | for CraftTweaker, but for GroovyScript it doesn't require another mod. 5 | 6 | !!! Note 7 | Requires version 0.4.0+.
8 | Before you start adding content make sure to specify the pack name and id in 9 | your [runConfig](../../introduction/getting_started.md#run-config).
10 | Also make sure to read [pack name and id](../../introduction/getting_started.md#pack-name-and-id) 11 | 12 | Currently, GroovyScript adds helpers to create 13 | 14 | - [items](item.md) 15 | - [blocks](block.md) 16 | - [creative tabs](creative_tab.md) 17 | - [fluids](fluid.md) 18 | 19 | Coming in the future: 20 | 21 | - Mekanism gases 22 | 23 | ## Creative tabs 24 | You can set a default creative tab which registered items and blocks will use if not specified otherwise 25 | ```groovy 26 | content.setDefaultCreativeTab(CreativeTabs tab) 27 | ``` 28 | 29 | !!! example 30 | 31 | With [that](creative_tab.md) we can do this 32 | ```groovy 33 | def creativeTab = content.createCreativeTab("nomifactory.creative_tab", item("nomifactory:heart_of_the_universe")) 34 | content.setDefaultCreativeTab(creativeTab) 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/block_event/crop_grow_event.md: -------------------------------------------------------------------------------- 1 | # BlockEvent.CropGrowEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.world.BlockEvent.CropGrowEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [BlockEvent](block_event.md) 11 | 12 | ## Methods 13 | # BlockEvent.CropGrowEvent.Pre 14 | 15 | To use this event use the following import: 16 | ```groovy 17 | import net.minecraftforge.event.world.BlockEvent.CropGrowEvent.Pre 18 | ``` 19 | 20 | ## Sub-Classes 21 | This event extends the following events and can use all their methods and fields:
22 | [CropGrowEvent](crop_grow_event.md), [BlockEvent](block_event.md) 23 | 24 | ## Methods 25 | ```groovy 26 | boolean hasResult() 27 | ``` 28 | 29 | # BlockEvent.CropGrowEvent.Post 30 | 31 | To use this event use the following import: 32 | ```groovy 33 | import net.minecraftforge.event.world.BlockEvent.CropGrowEvent.Post 34 | ``` 35 | 36 | ## Sub-Classes 37 | This event extends the following events and can use all their methods and fields:
38 | [CropGrowEvent](crop_grow_event.md), [BlockEvent](block_event.md) 39 | 40 | ## Methods 41 | ```groovy 42 | net.minecraft.block.state.IBlockState getOriginalState() 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /docs/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | 2 | .md-grid { 3 | margin-left: 0; 4 | margin-right: 0; 5 | max-width: none; 6 | } 7 | 8 | [data-md-color-scheme="slate"] { 9 | --md-typeset-a-color: #7087E0; 10 | } 11 | 12 | .md-typeset .admonition, 13 | .md-typeset details { 14 | font-size: 0.80rem; 15 | } 16 | 17 | .md-source-file__part { 18 | color: var(--md-default-fg-color--light); 19 | display: inline-flex; 20 | gap: 0.5rem; 21 | margin-right: 0.5rem; 22 | } 23 | 24 | .md-footer-actions { 25 | float: right; 26 | direction: rtl; 27 | } 28 | 29 | .md-footer-actions .md-content__button { 30 | float: none 31 | } 32 | 33 | /* 34 | * By checking that the parent doesn't have `#fakeGivePriority`, we get a selector specificity of 1-1-1, which we need to beat a 0-5-0 applying specific margins. 35 | * Definitely better than just using `!important` four times, trust me. 36 | */ 37 | div:not(#fakeGivePriority) .md-content__inner { 38 | width: 80%; 39 | margin-left: auto; 40 | margin-right: auto; 41 | } 42 | 43 | .md-sidebar--primary { 44 | width: 16rem; 45 | } 46 | 47 | @media screen and (max-width: 76.2344em) { 48 | 49 | div:not(#fakeGivePriority) .md-content__inner { 50 | margin: 0 .8rem 1.2rem; 51 | width: auto; 52 | } 53 | 54 | .md-sidebar--primary { 55 | width: 12.1rem; 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /overrides/partials/source-file.html: -------------------------------------------------------------------------------- 1 | {# https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/source-file.html #} 2 | 3 | {% import "partials/language.html" as lang with context %} 4 | 5 | 6 |
7 |
8 | {# mkdocs-git-revision-date-localized-plugin #} 9 | {% if page.meta.git_revision_date_localized %} 10 | 11 | 12 | {% include ".icons/material/clock-edit-outline.svg" %} 13 | 14 | {{ page.meta.git_revision_date_localized }} 15 | 16 | {% endif %} 17 | {% if page.meta.git_creation_date_localized %} 18 | 19 | 20 | {% include ".icons/material/clock-plus-outline.svg" %} 21 | 22 | {{ page.meta.git_creation_date_localized }} 23 | 24 | {% endif %} 25 | 26 | {# Include the source code actions partial #} 27 | 28 | {% include "partials/actions.html" %} 29 | 30 | 31 |
32 | -------------------------------------------------------------------------------- /docs/groovy/maps.md: -------------------------------------------------------------------------------- 1 | # Maps 2 | Maps are similar to lists, but they assign each value to a key. 3 | Meaning instead of accessing the value by the index, you can get it by using the key. 4 | Each key can only have one value, but multiple values can have the same key. 5 | 6 | There different types of maps. Javas default map is `HashMap`. 7 | It doesn't keep the elements order causing the elements to be seemingly random. 8 | 9 | Groovy uses `Object2ObjectLinkedOpenHashMap` by default. It is slightly more memory efficient and keeps the element order. 10 | 11 | The key and value can be of different types. If the key is a string you can leave out the `'` or `"`. 12 | ```groovy 13 | def simpleMap = [:] // a empty ordered hash map 14 | def hashMap = new HashMap() // a empty unordered hash map 15 | 16 | // this maps the short form of some periodic elements to their real name 17 | def elements = [ 18 | Au: 'Gold', 19 | Ag: 'Silver', 20 | Pb: 'Lead', 21 | H: 'Hydrogen' 22 | ] 23 | ``` 24 | 25 | ## Getting values 26 | We are using the map we created above here. 27 | ```groovy 28 | println(elements['Pb']) // Lead 29 | println(elements['Ag']) // Silver 30 | println(elements['B']) // null since there is no key 'B' 31 | ``` 32 | 33 | ## Modifying maps 34 | We are using the map we created above here. 35 | ```groovy 36 | elements['Au'] = 'Copper' // Au is know mapped to copper 37 | elements.remove('H') // removes H: Hydrogen 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/botania/knowledge.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Lexicon Knowledge" 3 | description: "Creates a new type of knowledge that Lexica Botania entries may be gated with. Can only be created." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/botania/Knowledge.java" 5 | --- 6 | 7 | # Lexicon Knowledge (Botania) 8 | 9 | ## Description 10 | 11 | Creates a new type of knowledge that Lexica Botania entries may be gated with. Can only be created. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.botania.knowledge/*(1)!*/ 19 | mods.botania.Knowledge 20 | ``` 21 | 22 | 1. This identifier will be used as the default for examples on this page 23 | 24 | ## Adding Entries 25 | 26 | - Adds entries in the format `id`, `formatting`: 27 | 28 | ```groovy 29 | mods.botania.knowledge.add(String, TextFormatting) 30 | ``` 31 | 32 | - Adds entries in the format `id`, `formatting`, `autoUnlock`: 33 | 34 | ```groovy 35 | mods.botania.knowledge.add(String, TextFormatting, boolean) 36 | ``` 37 | 38 | ???+ Example 39 | ```groovy 40 | mods.botania.knowledge.add('newType', TextFormatting.RED, true) 41 | ``` 42 | 43 | ## Getting the value of entries 44 | 45 | - Iterates through every entry in the registry: 46 | 47 | ```groovy 48 | mods.botania.knowledge.streamKnowledgeTypes() 49 | ``` 50 | -------------------------------------------------------------------------------- /docs/groovyscript/external_compat.md: -------------------------------------------------------------------------------- 1 | Here you'll learn about adding external mod compat for GroovyScript. 2 | 3 | !!! Note 4 | You need at least version 0.7.0. 5 | 6 | !!! Note 7 | Please read the javadoc for the interface and methods. 8 | 9 | The plugin must implement `GroovyPlugin`. GroovyScript will automatically find the class and instantiate it. If the 10 | instance field is non-null the class will not be instantiated by GroovyScript, but instead the value of the field will 11 | be used. 12 | 13 | The field `TestReg test` represents a machine that can have recipes. 14 | 15 | In `onCompatLoaded()` the compat can be initialised. `container.getVirtualizedRegistrar().addFieldsOf(this)` 16 | automatically register fields of this class which are `VirtualRegistries` including the `TestReg test` field. 17 | 18 | ````java 19 | public class ExampleModGroovyPlugin implements GroovyPlugin { 20 | 21 | public final TestReg test = new TestReg(); 22 | 23 | @Override 24 | public @NotNull String getModId() { 25 | return "example_id"; 26 | } 27 | 28 | @Override 29 | public @NotNull String getModName() { 30 | return "example_name"; 31 | } 32 | 33 | @Override 34 | public void onCompatLoaded(GroovyContainer container) { 35 | GroovyScript.LOGGER.info("ExampleMod container loaded"); 36 | container.getVirtualizedRegistrar().addRegistry(VanillaModule.furnace); 37 | container.getVirtualizedRegistrar().addFieldsOf(this); 38 | } 39 | } 40 | ```` -------------------------------------------------------------------------------- /overrides/partials/actions.html: -------------------------------------------------------------------------------- 1 | {# https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/actions.html #} 2 | 3 | {% if page.edit_url %} 4 | {% if "/blob/" in page.edit_url %} 5 | {% set part = "blob" %} 6 | {% else %} 7 | {% set part = "edit" %} 8 | {% endif %} 9 | 10 | {# Edit button #} 11 | {% if "content.action.edit" in features %} 12 | 17 | {% set icon = config.theme.icon.edit or "material/file-edit-outline" %} 18 | {% include ".icons/" ~ icon ~ ".svg" %} 19 | 20 | {% endif %} 21 | {# View button #} 22 | {% if "content.action.view" in features %} 23 | 28 | {% set icon = config.theme.icon.view or "material/file-eye-outline" %} 29 | {% include ".icons/" ~ icon ~ ".svg" %} 30 | 31 | {% endif %} 32 | {# Source Code button #} 33 | {% if page.meta.source_code_link %} 34 | 39 | {% set icon = config.theme.icon.source or "material/file-code-outline" %} 40 | {% include ".icons/" ~ icon ~ ".svg" %} 41 | 42 | {% endif %} 43 | {% endif %} 44 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/events/populate_chunk_event/populate_chunk_event.md: -------------------------------------------------------------------------------- 1 | # PopulateChunkEvent 2 | 3 | To use this event use the following import: 4 | ```groovy 5 | import net.minecraftforge.event.terraingen.PopulateChunkEvent 6 | ``` 7 | 8 | ## Sub-Classes 9 | This event extends the following events and can use all their methods and fields:
10 | [ChunkGeneratorEvent](../chunk_generator_event/chunk_generator_event.md) 11 | 12 | ## Methods 13 | ```groovy 14 | boolean isHasVillageGenerated() 15 | ``` 16 | 17 | ```groovy 18 | net.minecraft.world.World getWorld() 19 | ``` 20 | 21 | ```groovy 22 | int getChunkZ() 23 | ``` 24 | 25 | ```groovy 26 | int getChunkX() 27 | ``` 28 | 29 | ```groovy 30 | java.util.Random getRand() 31 | ``` 32 | 33 | # PopulateChunkEvent.Pre 34 | 35 | To use this event use the following import: 36 | ```groovy 37 | import net.minecraftforge.event.terraingen.PopulateChunkEvent.Pre 38 | ``` 39 | 40 | ## Sub-Classes 41 | This event extends the following events and can use all their methods and fields:
42 | [PopulateChunkEvent](populate_chunk_event.md), [ChunkGeneratorEvent](../chunk_generator_event/chunk_generator_event.md) 43 | 44 | ## Methods 45 | # PopulateChunkEvent.Post 46 | 47 | To use this event use the following import: 48 | ```groovy 49 | import net.minecraftforge.event.terraingen.PopulateChunkEvent.Post 50 | ``` 51 | 52 | ## Sub-Classes 53 | This event extends the following events and can use all their methods and fields:
54 | [PopulateChunkEvent](populate_chunk_event.md), [ChunkGeneratorEvent](../chunk_generator_event/chunk_generator_event.md) 55 | 56 | ## Methods 57 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/thaumcraft/warp.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Warp" 3 | description: "Determines if holding an item or equipping a piece of armor or a bauble gives warp, and how much warp it gives" 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/thaumcraft/warp/Warp.java" 5 | --- 6 | 7 | # Warp (Thaumcraft) 8 | 9 | ## Description 10 | 11 | Determines if holding an item or equipping a piece of armor or a bauble gives warp, and how much warp it gives 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.thaumcraft.warp/*(1)!*/ 19 | mods.thaumcraft.Warp 20 | mods.tc.warp 21 | mods.tc.Warp 22 | mods.thaum.warp 23 | mods.thaum.Warp 24 | ``` 25 | 26 | 1. This identifier will be used as the default for examples on this page 27 | 28 | ## Adding Recipes 29 | 30 | - Adds Warp to the given item in the format `item`, `amount`: 31 | 32 | ```groovy 33 | mods.thaumcraft.warp.addWarp(ItemStack, int) 34 | ``` 35 | 36 | ???+ Example 37 | ```groovy 38 | mods.thaumcraft.warp.addWarp(item('minecraft:pumpkin'), 3) 39 | ``` 40 | 41 | ## Removing Recipes 42 | 43 | - Removes Warp from the given item: 44 | 45 | ```groovy 46 | mods.thaumcraft.warp.removeWarp(ItemStack) 47 | ``` 48 | 49 | - Removes all registered recipes: 50 | 51 | ```groovy 52 | mods.thaumcraft.warp.removeAll() 53 | ``` 54 | 55 | ???+ Example 56 | ```groovy 57 | mods.thaumcraft.warp.removeWarp(item('thaumcraft:void_hoe')) 58 | mods.thaumcraft.warp.removeAll() 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to GroovyScript 2 | 3 | A comprehensive scripting sandbox for Minecraft 1.12.2.
4 | [Join our Discord](https://discord.com/invite/m53yxTjjKM).
5 | 6 | Are you not seeing what other see on this wiki? Try reloading it. 7 | 8 | ## Features 9 | 10 | 1. Groovy: a powerful and tested scripting language 11 | - Java-compatible syntax + interoperable code 12 | - Static compilation 13 | - Optional dynamic typing 14 | - Metaprogramming 15 | 2. Sandboxed: scripts are effectively ran in a sandbox, with sensitive operations blacklisted from being called or referenced 16 | 3. Reloading: able to test script changes within the game without restarting 17 | - Most if not all Forge Registry objects can be reloaded on the fly 18 | - Most mod registries are supported natively 19 | 4. Events: Easily listen to Forge's EventBuses with Groovy Closures 20 | 5. Familiarity: Bracket handlers for those that are familiar with CraftTweaker (currently implemented, may be removed in the near future) 21 | 6. Informational: commands to display rich information for the item in your hand and more 22 | 7. Optimized: Making sure no compromises are being made while delivering features with efficient code 23 | 8. API: Great catalogue of code for other mod authors to make their mods compatible with GroovyScript such as package/class/method/field blacklists 24 | 25 | ### Where to go? 26 | 27 | Check [this](introduction/getting_started.md) out to get started.
28 | Check out the Groovy tab for infos about the Groovy language.
29 | Check out the GroovyScript for the GroovyScript documentation.
30 | 31 | !!! Note 32 | This wiki is highly WIP. There is still a lot of info missing. We would appreciate any help to improve this place. 33 | Get started by joining our [Discord](https://discord.com/invite/m53yxTjjKM) 34 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/appliedenergistics2/cannon_ammo.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Cannon Ammo" 3 | description: "Item and weight, where weight is a factor in how much damage is dealt." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/appliedenergistics2/CannonAmmo.java" 5 | --- 6 | 7 | # Cannon Ammo (Applied Energistics 2) 8 | 9 | ## Description 10 | 11 | Item and weight, where weight is a factor in how much damage is dealt. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="7" 18 | mods.ae2.cannon_ammo 19 | mods.ae2.cannonammo 20 | mods.ae2.cannonAmmo 21 | mods.ae2.CannonAmmo 22 | mods.ae2.cannon 23 | mods.ae2.Cannon 24 | mods.appliedenergistics2.cannon_ammo/*(1)!*/ 25 | mods.appliedenergistics2.cannonammo 26 | mods.appliedenergistics2.cannonAmmo 27 | mods.appliedenergistics2.CannonAmmo 28 | mods.appliedenergistics2.cannon 29 | mods.appliedenergistics2.Cannon 30 | ``` 31 | 32 | 1. This identifier will be used as the default for examples on this page 33 | 34 | ## Adding Entries 35 | 36 | - Adds ammo in the format `item`, `value`: 37 | 38 | ```groovy 39 | mods.appliedenergistics2.cannon_ammo.add(ItemStack, double) 40 | ``` 41 | 42 | ???+ Example 43 | ```groovy 44 | mods.appliedenergistics2.cannon_ammo.add(item('minecraft:clay'), 10000) 45 | ``` 46 | 47 | ## Removing Entries 48 | 49 | - Removes the ammo entry for the given item: 50 | 51 | ```groovy 52 | mods.appliedenergistics2.cannon_ammo.remove(ItemStack) 53 | ``` 54 | 55 | - Removes all registered recipes: 56 | 57 | ```groovy 58 | mods.appliedenergistics2.cannon_ammo.removeAll() 59 | ``` 60 | 61 | ???+ Example 62 | ```groovy 63 | mods.appliedenergistics2.cannon_ammo.remove(item('minecraft:gold_nugget')) 64 | mods.appliedenergistics2.cannon_ammo.removeAll() 65 | ``` 66 | -------------------------------------------------------------------------------- /docs/groovy/lists.md: -------------------------------------------------------------------------------- 1 | # Lists 2 | Lists are data types that can hold multiple values of a certain type. 3 | 4 | Lists are dynamically sized. So that means if we create a list of 0 length, we can still add elements to it. 5 | There are multiple ways to create lists. The elements of a list are ordered, so the order wont change randomly. 6 | ```groovy 7 | // most simple list, size = 0 8 | // the type is always ArrayList 9 | def simpleList = [] 10 | def list = new ArrayList() // this is the same as above 11 | 12 | def anotherList = ['He', 'llo', ' w', 'or', 'ld!'] // we can put values into the list, all of the same type 13 | ``` 14 | 15 | ## Getting values 16 | Elements of a list can bee accessed via `get` or the `[]` operator. 17 | Lists index start at 0. 18 | ```groovy 19 | def list = [9, 8, 7, 6, 5, 4, 3, 2, 1] 20 | println(list[0]) // 9 21 | println(list.get(0)) // 9 22 | println(list[3]) // prints the 4th element: 6 23 | println(list[-1]) // prints the last element: 1 24 | println(list[-2]) // prints the 2nd last element: 2 25 | ``` 26 | 27 | You can also get a range of elements by using the `..` operator. 28 | ```groovy 29 | def list = [9, 8, 7, 6, 5, 4, 3, 2, 1] 30 | def subList = list[2..5] // [7, 6, 5, 4] 31 | // reversing the indexes results in a reversed list 32 | def subLis2 = list[5..2] // [4, 5, 6, 7] 33 | // -1 is greater because it refers to the last elements, so its not reversed 34 | def subList3 = list[2..-1] // [7, 6, 5, 4, 3, 2, 1] 35 | ``` 36 | 37 | ## Modifying lists 38 | Lists can modified by using `set()`, `add()` and `remove()`. 39 | We can also use the `[]` and `<<` operators 40 | ```groovy 41 | def list = [] 42 | list.add(1) // adds 1 to the lest 43 | // list is now [1] 44 | list << 3 // adds 3 to the list 45 | list << 9 46 | // [1, 3, 9] 47 | list.set(1, 5) // sets the element at index 1 to 5 48 | list[1] = 5 // same thing as above 49 | // [1, 5, 9] 50 | list.remove(0) // removes the first element 51 | // [5, 9] 52 | ``` -------------------------------------------------------------------------------- /docs/groovyscript/mods/thermal/pulverizer.md: -------------------------------------------------------------------------------- 1 | # Thermal Expansion Pulverizer 2 | 3 | ## Adding Recipes 4 | 5 | Just like other recipe types, the Pulverizer also uses a recipe builder.
6 | You don't know what a builder is? Check [this](https://groovyscript-docs.readthedocs.io/en/latest/groovy/builder/) out 7 | 8 | ```groovy 9 | mods.thermalexpansion.Pulverizer.recipeBuilder() 10 | ``` 11 | 12 | Set input: (requires exactly 1) 13 | 14 | ```groovy 15 | .input(IIngredient) 16 | ``` 17 | 18 | Set output: (requires exactly 1) 19 | 20 | ```groovy 21 | .output(ItemStack) 22 | ``` 23 | 24 | Set secondary Output: (optional) 25 | 26 | ```groovy 27 | .secondaryOutput(ItemStack) // default chance is 100% 28 | .secondaryOutput(ItemStack, int chance) // chance is a number from 0 to 100 where 100 is 100% 29 | ``` 30 | 31 | Set required total energy: (optional (default is 3000)) 32 | 33 | ```groovy 34 | .energy(int) 35 | ``` 36 | 37 | Register recipe: (returns `cofh.thermalexpansion.util.managers.machine.PulverizerManager.PulverizerRecipe`) 38 | 39 | ```groovy 40 | .register() 41 | ``` 42 | 43 | !!! example 44 | 45 | This creates a recipe where bookshelf turns into a diamond with an extra 1% chance for an extra diamond. 46 | 47 | ```groovy 48 | mods.thermalexpansion.Pulverizer.recipeBuilder() 49 | .input(item('minecraft:bookshelf')) 50 | .output(item('minecraft:diamond')) 51 | .secondaryOutput(item('minecraft:diamond'), 1) 52 | .energy(2000) 53 | .register() 54 | ``` 55 | 56 | ## Removing Recipes 57 | 58 | This removes a recipe that match the given input: 59 | 60 | ```groovy 61 | mods.thermalexpansion.Pulverizer.removeByInput(ItemStack input) 62 | ``` 63 | 64 | !!! example 65 | 66 | ```groovy 67 | // removes recipe with Iron Ingot as input from Pulverizer 68 | mods.thermalexpansion.Pulverizer.removeByInput(item('minecraft:iron_ingot')) 69 | ``` 70 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/astralsorcery/perk_tree_config.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Perk Tree Config" 3 | description: "Control the Perk level cap and XP formula." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/astralsorcery/perktree/PerkTreeConfig.java" 5 | --- 6 | 7 | # Perk Tree Config (Astral Sorcery) 8 | 9 | ## Description 10 | 11 | Control the Perk level cap and XP formula. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="5" 18 | mods.astral_sorcery.perk_tree_config 19 | mods.astral_sorcery.perktreeconfig 20 | mods.astral_sorcery.perkTreeConfig 21 | mods.astral_sorcery.PerkTreeConfig 22 | mods.astralsorcery.perk_tree_config/*(1)!*/ 23 | mods.astralsorcery.perktreeconfig 24 | mods.astralsorcery.perkTreeConfig 25 | mods.astralsorcery.PerkTreeConfig 26 | mods.astral.perk_tree_config 27 | mods.astral.perktreeconfig 28 | mods.astral.perkTreeConfig 29 | mods.astral.PerkTreeConfig 30 | mods.as.perk_tree_config 31 | mods.as.perktreeconfig 32 | mods.as.perkTreeConfig 33 | mods.as.PerkTreeConfig 34 | ``` 35 | 36 | 1. This identifier will be used as the default for examples on this page 37 | 38 | ## Editing Values 39 | 40 | - Sets the maximum level of Astral Sorcery's Perks, between 1 and 100: 41 | 42 | ```groovy 43 | mods.astralsorcery.perk_tree_config.setLevelCap(int) 44 | ``` 45 | 46 | - Sets the Experience cost to advance to the next level, with the Closure taking 2 parameters, `int levelNumber` and `long previousLevelCost` and returning a `long`: 47 | 48 | ```groovy 49 | mods.astralsorcery.perk_tree_config.setXpFunction(Closure) 50 | ``` 51 | 52 | ???+ Example 53 | ```groovy 54 | mods.astralsorcery.perk_tree_config.setLevelCap(50) 55 | mods.astralsorcery.perk_tree_config.setXpFunction({ int i, long prev -> prev + 1000L + MathHelper.lfloor(Math.pow(2.0, i / 2.0F + 3)) }) 56 | ``` 57 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/ore_dictionary.md: -------------------------------------------------------------------------------- 1 | # Ore Dictionary 2 | 3 | !!! Note 4 | Requires version 0.3.0+ 5 | GroovyScript also allows you to remove and add ore dictionaries to items and reload them. 6 | 7 | ## Getting an ore dict ingredient 8 | Ore dict ingredients can be used in any recipe that accepts `IIngredient`. 9 | !!! example 10 | ```groovy 11 | ore('ingotCopper') // returns all copper ingots 12 | ore('ingot*') // wildcards are also valid (returns all ingots) 13 | ``` 14 | 15 | ## Adding ore dicts 16 | 17 | All three methods are do exactly the same thing. 18 | 19 | !!! example 20 | 21 | ```groovy 22 | oreDict.add("amogus", item('minecraft:iron_ingot')) 23 | 24 | item('minecraft:iron_ingot').addOreDict(ore('amogus')) 25 | 26 | ore('amogus').add(item('minecraft:iron_ingot')) 27 | ``` 28 | 29 | ## Removing ore dicts 30 | 31 | All three methods are do exactly the same thing. 32 | 33 | !!! example 34 | 35 | ```groovy 36 | oreDict.remove("ingotIron", item('minecraft:iron_ingot')) 37 | 38 | item('minecraft:iron_ingot').removeOreDict(ore('ingotIron')) 39 | 40 | ore('ingotIron').remove(item('minecraft:iron_ingot')) 41 | ``` 42 | 43 | ## Other 44 | 45 | You can get all items from an ore dict. 46 | Both ways do the same thing. 47 | 48 | !!! example 49 | 50 | ```groovy 51 | oreDict.getItems('ingotIron') 52 | oreDict['ingotIron'] 53 | ``` 54 | 55 | Checking if an item is in an ore dictionary 56 | 57 | !!! example 58 | 59 | ```groovy 60 | item('minecraft:iron_ingot') in ore('ingotIron') // returns true 61 | ``` 62 | 63 | Getting the first item from an ore dictionary 64 | 65 | !!! example 66 | 67 | ```groovy 68 | ore('ingotIron').first 69 | ore('ingotIron')[0] 70 | ``` 71 | 72 | Iterating over all items in an ore dictionary 73 | 74 | !!! example 75 | 76 | ```groovy 77 | for (def ironIngot : ore('ingotIron')) { 78 | ... 79 | } 80 | ``` 81 | -------------------------------------------------------------------------------- /docs/groovyscript/minecraft/tooltip.md: -------------------------------------------------------------------------------- 1 | # Item Tooltips 2 | 3 | There is not a simple way to add tooltips. However, you can use the event system to modify any tooltip in any way you 4 | want.
5 | See [ItemTooltipEvent](events/item_tooltip_event.md). 6 | 7 | ## Adding lines 8 | 9 | This is the simplest way to add tooltips to a specific item. Note that this would ignore nbt data. Also, you can add 10 | tooltips for multiple items inside the event. You don't need to call listen for the same event multiple times. 11 | 12 | !!! example 13 | 14 | ```groovy 15 | import net.minecraftforge.event.entity.player.ItemTooltipEvent 16 | 17 | event_manager.listen { ItemTooltipEvent event -> 18 | if (event.getItemStack() in item('minecraft:diamond')) { 19 | event.getToolTip() << 'Epic diamond tooltip' 20 | } 21 | } 22 | ``` 23 | 24 | If you are familiar with [lists](../../groovy/lists.md), you can modify the tooltip lines as you like 25 | since `event.getToolTip()` returns a `List`. 26 | 27 | ## Writing your own addTooltip method 28 | The code shown above is somewhat complicated for beginners. You can write a helper method for that. 29 | However, this way is somewhat inefficient, and you might run into problems with large amounts of tooltips. 30 | 31 | ```groovy 32 | import net.minecraftforge.event.entity.player.ItemTooltipEvent 33 | 34 | def tooltipMap = [:] 35 | 36 | event_manager.listen { ItemTooltipEvent event -> 37 | for (def entry in tooltipMap) { // iterate tooltip map 38 | if (event.getItemStack() in entry.key) { // if the item in the event matches the map entry 39 | event.getTooltip() << entry.value // add the line of the map entry 40 | } 41 | } 42 | } 43 | 44 | def addTooltip(ItemStack itemStack, String line) { 45 | tooltipMap[itemStack] = line // store item and line in map 46 | } 47 | ``` 48 | 49 | Now you can simply call `addTooltip` to add tooltips. 50 | ```groovy 51 | addTooltip(item('minecraft:apple'), 'Hey, I am an apple.') 52 | ``` 53 | -------------------------------------------------------------------------------- /docs/groovy/loops.md: -------------------------------------------------------------------------------- 1 | # Loops 2 | Loops are useful if you want to do the operation multiple times or if you want to do a operation for each element in a list. 3 | 4 | ## While loop 5 | A simple while loop looks like this: 6 | ```groovy 7 | while (condition) { 8 | operation 9 | } 10 | ``` 11 | The condition is a boolean. As long as that condition evaluates to true, the operation will be executed. 12 | !!! example: 13 | This will print `0, 1, 2, 3, 4, 5, 6, 7, 8, 9`. 14 | ```groovy 15 | int i = 0; 16 | while (i < 10) { 17 | print("${i++}, ") 18 | } 19 | ``` 20 | 21 | There is also a `do while` loop which ignores the condition on its first run. 22 | ```groovy 23 | do { 24 | operation 25 | } while (condition) 26 | ``` 27 | 28 | ## For loop 29 | For loops are similar to while loops. 30 | ```groovy 31 | for(init; condition; incrementor) { 32 | operation 33 | } 34 | ``` 35 | `init` is called before the loop. `condition` is checked before each run and `incrementor` is called after each run. 36 | 37 | !!! example 38 | This will print `0, 1, 2, 3, 4, 5, 6, 7, 8, 9`. 39 | ```groovy 40 | for(int i = 0; i < 10; i++) { 41 | print("${i++}, ") 42 | } 43 | ``` 44 | 45 | ## Enhanced for loop 46 | Those are very useful for lists and maps. 47 | This will print `Hello world!` 48 | ```groovy 49 | def list = ['He', 'llo', ' w', 'or', 'ld!'] 50 | for(part in list) { 51 | print(part) 52 | } 53 | ``` 54 | `part` creates a new variable on each run for the current element in the list `lists`. 55 | 56 | For maps, it looks like this 57 | ```groovy 58 | def elements = [ 59 | 'Au': 'Gold', 60 | 'Ag': 'Silver', 61 | 'Pb': 'Lead', 62 | 'H' : 'Hydrogen' 63 | ] 64 | // prints al elements 65 | for (entry in elements) { 66 | println("${entry.key}: ${entry.value}") 67 | } 68 | ``` 69 | 70 | ## Control flow in loops 71 | `break` can be used at any time inside a loop to abort the current and all following runs. 72 | `continue` will only abort the current run and *continues* with the next run (if the condition is still true) 73 | 74 | 75 | -------------------------------------------------------------------------------- /docs/groovyscript/content/item.md: -------------------------------------------------------------------------------- 1 | # Creating items 2 | 3 | ## The simplest way 4 | 5 | ```groovy 6 | content.createItem(String name).register() 7 | ``` 8 | 9 | Simple right? 10 | Let's break it up: 11 | 12 | - `content` is a global variable. 13 | - `createItem(String name)` creates an item and returns it. The name is the registry name and must only consist of lower 14 | case letters and `_`. 15 | - `register()` registers the item. Without this the item will not appear in game. 16 | 17 | ## Registering an item 18 | 19 | The example above creates a simple item for you, but you can also create items yourself (to create custom behaviour). 20 | Use the following methods to register custom items. 21 | 22 | ```groovy 23 | content.registerItem(String name, Item item) 24 | ``` 25 | 26 | ## Texture 27 | 28 | Minecraft's items need a texture (or multiple) and a model file which describes how the textures are rendered. If groovy 29 | can't find a model file it will generate a default file 30 | at `.minecraft/groovy/assets/[pack id]/models/item/[item name].json`. 31 | It will point to a texture you will need to place 32 | at `.minecraft/groovy/assets/[pack id]/textures/items/[item name].png`. 33 | 34 | ## Translating the items name 35 | 36 | By default, the items name will show up as `item.[pack id].[item name].name`. To change that you need add an entry to 37 | the lang file. GroovyScript generates a default lang file at `.minecraft/groovy/assets/[pack id]/lang/en_us.lang`. 38 | 39 | !!! example 40 | 41 | First create an item 42 | 43 | ```groovy 44 | content.createItem('heart_of_the_universe') 45 | ``` 46 | 47 | Let's assume that the pack id is `nomifactory` so that the item id will be `nomifactory:heart_of_the_universe`. 48 | Insert this line into the lang file. 49 | 50 | ```mclang 51 | item.nomifactory.heart_of_the_universe.name=Heart of the universe 52 | ``` 53 | 54 | (`item.nomifactory.heart_of_the_universe.name` is the default generated translation key. You can change to anything you want.)
55 | Finally, put a texture at `.minecraft/groovy/assets/nomifactory/textures/items/heart_of_the_universe.png` 56 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/botania/orechid.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Orechid" 3 | description: "Converts stone blocks into one of a few ore blocks at the cost of mana." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/botania/Orechid.java" 5 | --- 6 | 7 | # Orechid (Botania) 8 | 9 | ## Description 10 | 11 | Converts stone blocks into one of a few ore blocks at the cost of mana. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.botania.orechid/*(1)!*/ 19 | mods.botania.Orechid 20 | ``` 21 | 22 | 1. This identifier will be used as the default for examples on this page 23 | 24 | ## Adding Recipes 25 | 26 | - Adds recipes in the format `output`, `weight`: 27 | 28 | ```groovy 29 | mods.botania.orechid.add(OreDictIngredient, int) 30 | ``` 31 | 32 | - Adds recipes in the format `output`, `weight`: 33 | 34 | ```groovy 35 | mods.botania.orechid.add(String, int) 36 | ``` 37 | 38 | ???+ Example 39 | ```groovy 40 | mods.botania.orechid.add(ore('oreEmerald'), 1350) 41 | mods.botania.orechid.add(ore('blockGold'), 1800) 42 | ``` 43 | 44 | ## Removing Recipes 45 | 46 | - Removes all recipes that match the given output: 47 | 48 | ```groovy 49 | mods.botania.orechid.removeByOutput(OreDictIngredient) 50 | ``` 51 | 52 | - Removes all recipes that match the given output: 53 | 54 | ```groovy 55 | mods.botania.orechid.removeByOutput(String) 56 | ``` 57 | 58 | - Removes all registered recipes: 59 | 60 | ```groovy 61 | mods.botania.orechid.removeAll() 62 | ``` 63 | 64 | ???+ Example 65 | ```groovy 66 | mods.botania.orechid.removeByOutput(ore('oreEmerald')) 67 | mods.botania.orechid.removeByOutput(ore('oreQuartz')) 68 | mods.botania.orechid.removeByOutput('oreCoal') 69 | mods.botania.orechid.removeAll() 70 | ``` 71 | 72 | ## Getting the value of recipes 73 | 74 | - Iterates through every entry in the registry, with the ability to call remove on any element to remove it: 75 | 76 | ```groovy 77 | mods.botania.orechid.streamRecipes() 78 | ``` 79 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/thaumcraft/loot_bag.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Lootbag" 3 | description: "Control what the different rarities of lootbag drop when opened." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/thaumcraft/LootBag.java" 5 | --- 6 | 7 | # Lootbag (Thaumcraft) 8 | 9 | ## Description 10 | 11 | Control what the different rarities of lootbag drop when opened. 12 | 13 | ???+ Warning 14 | This compat is not fully documented. Some or all of its features are not present on the wiki. View the source code to gain an accurate understanding of the compat. 15 | 16 | !!! Bug 17 | Armor chances are hard coded into randomized loot function, and are not currently removable. 18 | 19 | ## Identifier 20 | 21 | Refer to this via any of the following: 22 | 23 | ```groovy hl_lines="1" 24 | mods.thaumcraft.loot_bag/*(1)!*/ 25 | mods.thaumcraft.lootbag 26 | mods.thaumcraft.lootBag 27 | mods.thaumcraft.LootBag 28 | mods.tc.loot_bag 29 | mods.tc.lootbag 30 | mods.tc.lootBag 31 | mods.tc.LootBag 32 | mods.thaum.loot_bag 33 | mods.thaum.lootbag 34 | mods.thaum.lootBag 35 | mods.thaum.LootBag 36 | ``` 37 | 38 | 1. This identifier will be used as the default for examples on this page 39 | 40 | ## Adding Recipes 41 | 42 | - Adds an item with a given weight to the target lootbag in the format `item`, `chance`, `rarity`: 43 | 44 | ```groovy 45 | mods.thaumcraft.loot_bag.add(ItemStack, int, int) 46 | ``` 47 | 48 | ???+ Example 49 | ```groovy 50 | mods.thaumcraft.loot_bag.add(item('minecraft:diamond_block'), 100, 2) 51 | mods.thaumcraft.loot_bag.add(item('minecraft:dirt'), 100, 0) 52 | ``` 53 | 54 | ## Removing Recipes 55 | 56 | - Removes an item from the target lootbag in the format `item`, `rarity`: 57 | 58 | ```groovy 59 | mods.thaumcraft.loot_bag.remove(ItemStack, int) 60 | ``` 61 | 62 | - Removes all items from the target lootbag rarity: 63 | 64 | ```groovy 65 | mods.thaumcraft.loot_bag.removeAll(int) 66 | ``` 67 | 68 | ???+ Example 69 | ```groovy 70 | mods.thaumcraft.loot_bag.remove(item('minecraft:ender_pearl'), 0) 71 | mods.thaumcraft.loot_bag.removeAll(2) 72 | ``` 73 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/appliedenergistics2/spatial.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Spatial Storage Allowed Tile Entities" 3 | description: "Either the class itself or its String name to add or remove from the Tile Entities allowed in Spatial Storage." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/appliedenergistics2/Spatial.java" 5 | --- 6 | 7 | # Spatial Storage Allowed Tile Entities (Applied Energistics 2) 8 | 9 | ## Description 10 | 11 | Either the class itself or its String name to add or remove from the Tile Entities allowed in Spatial Storage. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="3" 18 | mods.ae2.spatial 19 | mods.ae2.Spatial 20 | mods.appliedenergistics2.spatial/*(1)!*/ 21 | mods.appliedenergistics2.Spatial 22 | ``` 23 | 24 | 1. This identifier will be used as the default for examples on this page 25 | 26 | ## Adding Entries 27 | 28 | - Adds the given class to the list of allowed TileEntities to be moved by Spatial Storage: 29 | 30 | ```groovy 31 | mods.appliedenergistics2.spatial.add(Class) 32 | ``` 33 | 34 | - Adds the given class to the list of allowed TileEntities to be moved by Spatial Storage: 35 | 36 | ```groovy 37 | mods.appliedenergistics2.spatial.add(String) 38 | ``` 39 | 40 | ???+ Example 41 | ```groovy 42 | mods.appliedenergistics2.spatial.add('net.minecraft.tileentity.TileEntityStructure') 43 | ``` 44 | 45 | ## Removing Entries 46 | 47 | - Removes the given class from the list of allowed TileEntities to be moved by Spatial Storage: 48 | 49 | ```groovy 50 | mods.appliedenergistics2.spatial.remove(Class) 51 | ``` 52 | 53 | - Removes the given class from the list of allowed TileEntities to be moved by Spatial Storage: 54 | 55 | ```groovy 56 | mods.appliedenergistics2.spatial.remove(String) 57 | ``` 58 | 59 | - Removes all registered recipes: 60 | 61 | ```groovy 62 | mods.appliedenergistics2.spatial.removeAll() 63 | ``` 64 | 65 | ???+ Example 66 | ```groovy 67 | mods.appliedenergistics2.spatial.remove('net.minecraft.tileentity.TileEntityChest') 68 | mods.appliedenergistics2.spatial.removeAll() 69 | ``` 70 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/botania/category.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Lexicon Category" 3 | description: "Category creates a new entry on the front page of the Lexica Botania." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/botania/Lexicon.java" 5 | --- 6 | 7 | # Lexicon Category (Botania) 8 | 9 | ## Description 10 | 11 | Category creates a new entry on the front page of the Lexica Botania. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.botania.category/*(1)!*/ 19 | mods.botania.Category 20 | ``` 21 | 22 | 1. This identifier will be used as the default for examples on this page 23 | 24 | ## Adding Entries 25 | 26 | - Adds a Category to the Lexica Botania in the format `name`, `icon` and a priority of 5: 27 | 28 | ```groovy 29 | mods.botania.category.add(String, ResourceLocation) 30 | ``` 31 | 32 | - Adds a Category to the Lexica Botania in the format `name`, `icon`, `priority`: 33 | 34 | ```groovy 35 | mods.botania.category.add(String, ResourceLocation, int) 36 | ``` 37 | 38 | ???+ Example 39 | ```groovy 40 | mods.botania.category.add('test', resource('minecraft:textures/items/apple.png')) 41 | mods.botania.category.add('first', resource('minecraft:textures/items/clay_ball.png'), 100) 42 | ``` 43 | 44 | ## Removing Entries 45 | 46 | - Removes a Category matching the given name: 47 | 48 | ```groovy 49 | mods.botania.category.remove(String) 50 | ``` 51 | 52 | - Removes a Category matching the given name: 53 | 54 | ```groovy 55 | mods.botania.category.removeCategory(String) 56 | ``` 57 | 58 | - Removes all registered recipes: 59 | 60 | ```groovy 61 | mods.botania.category.removeAll() 62 | ``` 63 | 64 | ???+ Example 65 | ```groovy 66 | mods.botania.category.remove('botania.category.alfhomancy') 67 | mods.botania.category.removeCategory('botania.category.misc') 68 | mods.botania.category.removeAll() 69 | ``` 70 | 71 | ## Getting the value of entries 72 | 73 | - Iterates through every entry in the registry, with the ability to call remove on any element to remove it: 74 | 75 | ```groovy 76 | mods.botania.category.streamCategories() 77 | ``` 78 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/botania/orechid_ignem.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Orechid Ignem" 3 | description: "Converts netherrack blocks into one of a few ore blocks at the cost of mana." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/botania/OrechidIgnem.java" 5 | --- 6 | 7 | # Orechid Ignem (Botania) 8 | 9 | ## Description 10 | 11 | Converts netherrack blocks into one of a few ore blocks at the cost of mana. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.botania.orechid_ignem/*(1)!*/ 19 | mods.botania.orechidignem 20 | mods.botania.orechidIgnem 21 | mods.botania.OrechidIgnem 22 | ``` 23 | 24 | 1. This identifier will be used as the default for examples on this page 25 | 26 | ## Adding Recipes 27 | 28 | - Adds recipes in the format `output`, `weight`: 29 | 30 | ```groovy 31 | mods.botania.orechid_ignem.add(OreDictIngredient, int) 32 | ``` 33 | 34 | - Adds recipes in the format `output`, `weight`: 35 | 36 | ```groovy 37 | mods.botania.orechid_ignem.add(String, int) 38 | ``` 39 | 40 | ???+ Example 41 | ```groovy 42 | mods.botania.orechid_ignem.add(ore('oreEmerald'), 1350) 43 | mods.botania.orechid_ignem.add(ore('blockGold'), 1800) 44 | ``` 45 | 46 | ## Removing Recipes 47 | 48 | - Removes all recipes that match the given output: 49 | 50 | ```groovy 51 | mods.botania.orechid_ignem.removeByOutput(OreDictIngredient) 52 | ``` 53 | 54 | - Removes all recipes that match the given output: 55 | 56 | ```groovy 57 | mods.botania.orechid_ignem.removeByOutput(String) 58 | ``` 59 | 60 | - Removes all registered recipes: 61 | 62 | ```groovy 63 | mods.botania.orechid_ignem.removeAll() 64 | ``` 65 | 66 | ???+ Example 67 | ```groovy 68 | mods.botania.orechid_ignem.removeByOutput(ore('oreEmerald')) 69 | mods.botania.orechid_ignem.removeByOutput(ore('oreQuartz')) 70 | mods.botania.orechid_ignem.removeByOutput('oreQuartz') 71 | mods.botania.orechid_ignem.removeAll() 72 | ``` 73 | 74 | ## Getting the value of recipes 75 | 76 | - Iterates through every entry in the registry, with the ability to call remove on any element to remove it: 77 | 78 | ```groovy 79 | mods.botania.orechid_ignem.streamRecipes() 80 | ``` 81 | -------------------------------------------------------------------------------- /docs/groovyscript/content/block.md: -------------------------------------------------------------------------------- 1 | # Creating blocks 2 | 3 | ## The simplest way 4 | 5 | ```groovy 6 | content.createBlock(String name).register() 7 | ``` 8 | 9 | Simple right? 10 | Let's break it up: 11 | 12 | - `content` is a global variable. 13 | - `createBlock(String name)` creates a block and an item version and returns it. The name is the registry name and must only consist of lower 14 | case letters and `_`. 15 | - `register()` registers the block and the item. Without this the block will not appear in game. 16 | 17 | ## Registering a block 18 | 19 | The example above creates a simple block for you, but you can also create blocks yourself (to create custom behaviour). 20 | Use the following methods to register custom blocks. 21 | 22 | ```groovy 23 | content.registerBlock(String name, Block block) 24 | content.registerBlock(String name, Block block, ItemBlock block) 25 | ``` 26 | 27 | ## Texture 28 | 29 | Minecraft's blocks need a texture (or multiple), a model file which describes how the textures are rendered and a block state file which points each block state to a model file. If groovy 30 | can't find a model file or a block state file it will generate default files 31 | at `.minecraft/groovy/assets/[pack id]/models/block/[block name].json` and `.minecraft/groovy/assets/[pack id]/blockstates/[item name].json`. 32 | It will point to a texture you will need to place 33 | at `.minecraft/groovy/assets/[pack id]/textures/blocks/[block name].png`. 34 | 35 | ## Translating the items name 36 | 37 | By default, the items name will show up as `tile.[pack id].[block name].name`. To change that you need add an entry to 38 | the lang file. GroovyScript generates a default lang file at `.minecraft/groovy/assets/[pack id]/lang/en_us.lang`. 39 | 40 | !!! example 41 | 42 | First create a block 43 | 44 | ```groovy 45 | content.createBlock('dust_block') 46 | ``` 47 | 48 | Let's assume that the pack id is `nomifactory` so that the item and block id will be `nomifactory:dust_block`. 49 | Insert this line into the lang file. 50 | 51 | ```mclang 52 | tile.nomifactory.dust_block.name=Heart of the universe 53 | ``` 54 | 55 | (`tile.nomifactory.dust_block.name` is the default generated translation key. You can change to anything you want.)
56 | Finally, put a texture at `.minecraft/groovy/assets/nomifactory/textures/items/dust_block.png` 57 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/gtceu/recipes.md: -------------------------------------------------------------------------------- 1 | # Recipes 2 | 3 | GTCEu has a great recipe structure. Adding and removing is pretty much the same for each machine. 4 | Recipes for a machine are stored in a `RecipeMap`. 5 | You can get a recipe map like this: 6 | 7 | ```groovy 8 | def recipeMap = mods.gregtech.recipe_map_name 9 | // this works also: 10 | def recipeMap2 = recipemap('recipe_map_name') 11 | ``` 12 | 13 | You can find a list of all machines [here](https://github.com/GregTechCEu/GregTech/wiki/CraftTweaker-for-Machines).
14 | Let's use `alloy_smelter` as an example here. 15 | With the recipe map you can create a recipe builder. 16 | 17 | ```groovy 18 | mods.gregtech.alloy_smelter.recipeBuilder() 19 | ``` 20 | 21 | You don't know what a builder is? Check [this](../../../groovy/builder.md) out. 22 | 23 | ## Builder functions 24 | 25 | GregTechs recipe builder has tons of helper functions. We'll only focus on the important ones. 26 | 27 | ### Adding inputs 28 | 29 | Works for fluid and items 30 | 31 | ```groovy 32 | inputs(IIngredient ingredient) 33 | inputs(IIngredient... ingredients) 34 | inputs(Collection ingredients) 35 | notConsumable(IIngredient ingredient) // this will not be consumed 36 | ``` 37 | 38 | ### Adding outputs 39 | 40 | ```groovy 41 | outputs(ItemStack) 42 | outputs(ItemStack...) 43 | outputs(Collection) 44 | chancedOutput(ItemStack, int chance, int tierChanceBoost) // this will not be consumed 45 | 46 | fluidOutputs(FluidStack) 47 | fluidOutputs(FluidStack...) 48 | fluidOutputs(Collection) 49 | ``` 50 | 51 | ### Other 52 | 53 | ```groovy 54 | duration(int duration) // base recipe duration int ticks (20 ticks = 1 sec) 55 | EUt(int EUt) 56 | hidden() // hides recipe in jei 57 | 58 | cleanroom(CleanroomType) // makes the recipe require cleanroom 59 | ``` 60 | 61 | ### Register recipe 62 | 63 | ```groovy 64 | buildAndRegister() 65 | ``` 66 | 67 | ## Example 68 | 69 | ```groovy 70 | import gregtech.api.metatileentity.multiblock.CleanroomType // needed when you want to use cleanroom 71 | 72 | mods.gregtech.alloy_smelter.recipeBuilder() 73 | .inputs(item('minecraft:dirt'), ore('stone')) 74 | .outputs(item('minecraft:nether_star') * 2) 75 | .cleanroom(CleanroomType.CLEANROOM) // CLEANROOM and STERILE_CLEANROOM are valid 76 | .duration(200) // 10 seconds 77 | .EUt(512) // HV recipe 78 | .buildAndRegister() 79 | ``` 80 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/enderio/fluid_fuel.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Fluid Fuel" 3 | description: "Create a Fuel with a given power per tick and total burn time that produces power with a Coolant while in a Combustion Generator." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/enderio/FluidFuel.java" 5 | --- 6 | 7 | # Fluid Fuel (Ender IO) 8 | 9 | ## Description 10 | 11 | Create a Fuel with a given power per tick and total burn time that produces power with a Coolant while in a Combustion Generator. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.enderio.fluid_fuel/*(1)!*/ 19 | mods.enderio.fluidfuel 20 | mods.enderio.fluidFuel 21 | mods.enderio.FluidFuel 22 | mods.enderio.combustion_fuel 23 | mods.enderio.combustionfuel 24 | mods.enderio.combustionFuel 25 | mods.enderio.CombustionFuel 26 | mods.eio.fluid_fuel 27 | mods.eio.fluidfuel 28 | mods.eio.fluidFuel 29 | mods.eio.FluidFuel 30 | mods.eio.combustion_fuel 31 | mods.eio.combustionfuel 32 | mods.eio.combustionFuel 33 | mods.eio.CombustionFuel 34 | ``` 35 | 36 | 1. This identifier will be used as the default for examples on this page 37 | 38 | ## Adding Recipes 39 | 40 | - Adds recipes in the format `fluid`, `rfPerCycle`, `totalBurnTime`: 41 | 42 | ```groovy 43 | mods.enderio.fluid_fuel.addFuel(Fluid, int, int) 44 | ``` 45 | 46 | - Adds recipes in the format `fluid`, `rfPerCycle`, `totalBurnTime`: 47 | 48 | ```groovy 49 | mods.enderio.fluid_fuel.addFuel(FluidStack, int, int) 50 | ``` 51 | 52 | ???+ Example 53 | ```groovy 54 | mods.enderio.fluid_fuel.addFuel(fluid('lava'), 500, 1000) 55 | ``` 56 | 57 | ## Removing Recipes 58 | 59 | - Removes recipes matching the target fluid: 60 | 61 | ```groovy 62 | mods.enderio.fluid_fuel.remove(Fluid) 63 | ``` 64 | 65 | - Removes recipes matching the target fluid: 66 | 67 | ```groovy 68 | mods.enderio.fluid_fuel.remove(FluidStack) 69 | ``` 70 | 71 | - Removes all registered recipes: 72 | 73 | ```groovy 74 | mods.enderio.fluid_fuel.removeAll() 75 | ``` 76 | 77 | ???+ Example 78 | ```groovy 79 | mods.enderio.fluid_fuel.remove(fluid('fire_water')) 80 | mods.enderio.fluid_fuel.removeAll() 81 | ``` 82 | 83 | ## Getting the value of recipes 84 | 85 | - Iterates through every entry in the registry, with the ability to call remove on any element to remove it: 86 | 87 | ```groovy 88 | mods.enderio.fluid_fuel.streamRecipes() 89 | ``` 90 | -------------------------------------------------------------------------------- /docs/groovyscript/mods/enderio/fluid_coolant.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Fluid Coolant" 3 | description: "Create a Coolant with a given coolant rate that produces power with a Fuel while in a Combustion Generator." 4 | source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/mods/enderio/FluidCoolant.java" 5 | --- 6 | 7 | # Fluid Coolant (Ender IO) 8 | 9 | ## Description 10 | 11 | Create a Coolant with a given coolant rate that produces power with a Fuel while in a Combustion Generator. 12 | 13 | ## Identifier 14 | 15 | Refer to this via any of the following: 16 | 17 | ```groovy hl_lines="1" 18 | mods.enderio.fluid_coolant/*(1)!*/ 19 | mods.enderio.fluidcoolant 20 | mods.enderio.fluidCoolant 21 | mods.enderio.FluidCoolant 22 | mods.enderio.combustion_coolant 23 | mods.enderio.combustioncoolant 24 | mods.enderio.combustionCoolant 25 | mods.enderio.CombustionCoolant 26 | mods.eio.fluid_coolant 27 | mods.eio.fluidcoolant 28 | mods.eio.fluidCoolant 29 | mods.eio.FluidCoolant 30 | mods.eio.combustion_coolant 31 | mods.eio.combustioncoolant 32 | mods.eio.combustionCoolant 33 | mods.eio.CombustionCoolant 34 | ``` 35 | 36 | 1. This identifier will be used as the default for examples on this page 37 | 38 | ## Adding Recipes 39 | 40 | - Adds recipes in the format `fluid`, `degreesPerMb`: 41 | 42 | ```groovy 43 | mods.enderio.fluid_coolant.addCoolant(Fluid, float) 44 | ``` 45 | 46 | - Adds recipes in the format `fluid`, `degreesPerMb`: 47 | 48 | ```groovy 49 | mods.enderio.fluid_coolant.addCoolant(FluidStack, float) 50 | ``` 51 | 52 | ???+ Example 53 | ```groovy 54 | mods.enderio.fluid_coolant.addCoolant(fluid('xpjuice'), 1000) 55 | ``` 56 | 57 | ## Removing Recipes 58 | 59 | - Removes recipes matching the target fluid: 60 | 61 | ```groovy 62 | mods.enderio.fluid_coolant.remove(Fluid) 63 | ``` 64 | 65 | - Removes recipes matching the target fluid: 66 | 67 | ```groovy 68 | mods.enderio.fluid_coolant.remove(FluidStack) 69 | ``` 70 | 71 | - Removes all registered recipes: 72 | 73 | ```groovy 74 | mods.enderio.fluid_coolant.removeAll() 75 | ``` 76 | 77 | ???+ Example 78 | ```groovy 79 | mods.enderio.fluid_coolant.remove(fluid('water')) 80 | mods.enderio.fluid_coolant.removeAll() 81 | ``` 82 | 83 | ## Getting the value of recipes 84 | 85 | - Iterates through every entry in the registry, with the ability to call remove on any element to remove it: 86 | 87 | ```groovy 88 | mods.enderio.fluid_coolant.streamRecipes() 89 | ``` 90 | --------------------------------------------------------------------------------