plugin_api.md

^{Copyright (C) 2016 - 2018 - BenBaptist and Wrapper.py developer(s).}

Welcome to the Wrapper.py Plugin API documentation!

The API is divided into modules. Click on each module to see it's documentation

api/wrapperconfig

api/base

api/minecraft

api/player

api/world

api/entity

api/backups

api/helpers

Click here for a list of Wrapper's events
Wrapper.py Events

Looking for a specific method? Look in this list to see which api module contains your desired method:

• addGroupPerm -> ↩base
• adjustBackupInterval -> ↩backups
• adjustBackupsKept -> ↩backups
• backupInProgress -> ↩backups
• backupIsIdle -> ↩backups
• banIp -> ↩minecraft
• banName -> ↩minecraft
• banUUID -> ↩minecraft
• blockForEvent -> ↩base
• broadcast -> ↩minecraft
• callEvent -> ↩base
• changeServerProps -> ↩minecraft
• chattocolorcodes -> ↩helpers
• checkPassword -> ↩base
• configWrapper -> ↩minecraft
• config_to_dict_read -> ↩helpers
• config_write_from_dict -> ↩helpers
• connect -> ↩player
• console -> ↩minecraft
• countActiveEntities -> ↩entity
• countEntitiesInPlayer -> ↩entity
• createGroup -> ↩base
• deOp -> ↩minecraft
• deleteGroup -> ↩base
• deleteGroupPerm -> ↩base
• disableBackups -> ↩backups
• enableBackups -> ↩backups
• epoch_to_timestr -> ↩helpers
• execute -> ↩player
• existsEntityByEID -> ↩entity
• fill -> ↩world
• format_bytes -> ↩helpers
• getAllPlayers -> ↩minecraft
• getBlock -> ↩world
• getClient -> ↩player
• getDimension -> ↩player
• getEntityByEID -> ↩entity
• getEntityControl -> ↩minecraft
• getEntityInfo -> ↩entity
• getFirstLogin -> ↩player
• getGameRules -> ↩minecraft
• getGamemode -> ↩player
• getGroups -> ↩player
• getHeldItem -> ↩player
• getItemInSlot -> ↩player
• getLevelInfo -> ↩minecraft
• getOfflineUUID -> ↩minecraft
• getPlayer -> ↩minecraft
• getPlayers -> ↩minecraft
• getPluginContext -> ↩base
• getPosition -> ↩player
• getServer -> ↩minecraft
• getServerPackets -> ↩minecraft
• getServerPath -> ↩minecraft
• getSpawnPoint -> ↩minecraft
• getStorage -> ↩base
• getTime -> ↩minecraft
• getTimeofDay -> ↩minecraft
• getUuidCache -> ↩minecraft
• getWorld -> ↩minecraft
• getWorldName -> ↩minecraft
• get_int -> ↩helpers
• getargs -> ↩helpers
• getargsafter -> ↩helpers
• getfileaslines -> ↩helpers
• getjsonfile -> ↩helpers
• getplayerby_eid -> ↩minecraft
• giveStatusEffect -> ↩minecraft
• hasGroup -> ↩player
• hasPermission -> ↩player
• hashPassword -> ↩base
• isIpBanned -> ↩minecraft
• isOp -> ↩player
• isServerStarted -> ↩minecraft
• isUUIDBanned -> ↩minecraft
• isipv4address -> ↩helpers
• kick -> ↩player
• killEntityByEID -> ↩entity
• lookupUUID -> ↩minecraft
• lookupbyName -> ↩minecraft
• lookupbyUUID -> ↩minecraft
• makeOp -> ↩minecraft
• message -> ↩minecraft
• message -> ↩player
• mkdir_p -> ↩helpers
• openWindow -> ↩player
• pardonIp -> ↩minecraft
• pardonName -> ↩minecraft
• pardonUUID -> ↩minecraft
• performBackup -> ↩backups
• pickle_load -> ↩helpers
• pickle_save -> ↩helpers
• processcolorcodes -> ↩helpers
• processoldcolorcodes -> ↩helpers
• pruneBackups -> ↩backups
• putjsonfile -> ↩helpers
• read_timestr -> ↩helpers
• readout -> ↩helpers
• refreshOpsList -> ↩minecraft
• registerCommand -> ↩base
• registerEvent -> ↩base
• registerHelp -> ↩base
• registerPermission -> ↩base
• removeGroup -> ↩player
• removePermission -> ↩player
• replace -> ↩world
• resetGroups -> ↩base
• resetPerms -> ↩player
• resetUsers -> ↩base
• say -> ↩player
• scrub_item_value -> ↩helpers
• sendAlerts -> ↩base
• sendBlock -> ↩player
• sendCommand -> ↩player
• sendEmail -> ↩base
• setBlock -> ↩minecraft
• setChunk -> ↩world
• setGamemode -> ↩player
• setGroup -> ↩player
• setLocalName -> ↩minecraft
• setPermission -> ↩player
• setPlayerAbilities -> ↩player
• setResourcePack -> ↩player
• setVisualXP -> ↩player
• set_item -> ↩helpers
• summonEntity -> ↩minecraft
• teleportAllEntities -> ↩minecraft
• uuid -> ↩player
• verifyTarInstalled -> ↩backups
• wrapperHalt -> ↩base
• wrapper_version -> ↩base