Class GrabBag

GrabBag API

Example Usage:

Check if GrabBag is installed....

$api = null;
if (($plugin = $server->getPluginManager()->getPlugin("GrabBag") !== null) && $plugin->isEnabled() && MPMU::apiCheck($plugin->getDescription()->getVersion(),"2.3")) {
  if ($plugin->api->getFeature("freeze-thaw")) $api = $plugin->api;
}

Call an API function:

$api->freeze($player);

Namespace: aliuly\grabbag\api
Located at GrabBag.php

Methods summary
`public`	# `__construct( aliuly\grabbag\Main $owner )` Parameters `$owner` plugin that owns this session
`public mixed\|null`	# `getModule( str $module )` Check if module is available... This will throw an exception if the module is not available Check if module is available... This will throw an exception if the module is not available Parameters `$module` module name Returns mixed\|null
`public boolean`	# `getFeature( str $feature )` Check if feature is supported and has been enabled in the GrabBag configuration file. Check if feature is supported and has been enabled in the GrabBag configuration file. Parameters `$feature` module name Returns boolean
`public`	# `getVars( )` Currently un-implemented Currently un-implemented
`public`	# `getInterp( )` Currently un-implemented Currently un-implemented
`public boolean`	# `isHardFreeze( )` Checks if hard or soft freezing Checks if hard or soft freezing Returns boolean
`public`	# `setHardFreeze( boolean $hard = true )` Sets hard or soft freezing Sets hard or soft freezing Parameters `$hard` if true (default) hard freeze is in effect.
`public boolean`	# `isFrozen( pocketmine\Player $player )` Checks if player is frozen Checks if player is frozen Parameters `$player` player to check Returns boolean
`public`	# `freeze( pocketmine\Player $player, boolean $freeze = true )` Freeze given player Freeze given player Parameters `$player` player to freeze `$freeze` if true (default) freeze, if false, thaw.
`public str[]`	# `getFrosties( )` Return a list of frozen players Return a list of frozen players Returns str[]
`public`	# `invisible( pocketmine\Player $player, boolean $invis )` Make player invisible Make player invisible Parameters `$player` player to change `$invis` if true (default) invisible, if false, visible.
`public`	# `isInvisible( pocketmine\Player $player )` Check if player is invisible... Check if player is invisible... Parameters `$player` player to check
`public`	# `after( integer $cmdline, str $secs )` Schedule a command to be run Schedule a command to be run Parameters `$cmdline` $secs - execute after this number of seconds `$secs` $cmdline - command line to execute
`public boolean`	# `alias( str $alias, str $cmdline, boolean $force = false )` Define a command alias Define a command alias Parameters `$alias` alias name `$cmdline` command line to execute `$force` overwrite existing commands Returns boolean true on succes, false on failure
`public boolean`	# `blowPlayer( pocketmine\Player $player, integer $yield, boolean $magic = false )` Blow player up Blow player up Parameters `$player` victim `$yield` explosion power `$magic` don't affect blocks Returns boolean true on succes, false on failure
`public`	# `setGlobalChat( boolean $mode )` Enable/Disable Chat globally Enable/Disable Chat globally Parameters `$mode` true, chat is active, false, chat is disabled
`public boolean`	# `getGlobalChat( )` Returns global chat status Returns global chat status Returns boolean
`public`	# `setPlayerChat( pocketmine\Player $player, boolean $mode )` Enable/Disable player's chat Enable/Disable player's chat Parameters `$player` `$mode` true, chat is active, false, chat is disabled
`public boolean`	# `getPlayerChat( pocketmine\Player $player )` Returns player's chat status Returns player's chat status Parameters `$player` Returns boolean
`public str[]`	# `getLeaders( )` Returns players that are leading others Returns players that are leading others Returns str[]
`public str[]`	# `getFollowers( pocketmine\Player $leader )` Returns followers of a certain leader Returns followers of a certain leader Parameters `$leader` Returns str[]
`public`	# `follow( pocketmine\Player $follower, pocketmine\Player $leader )` Make a player follow another Make a player follow another Parameters `$follower` `$leader`
`public`	# `stopFollowing( pocketmine\Player $follower )` Stop a player from following Stop a player from following Parameters `$follower`
`public`	# `stopLeading( pocketmine\Player $leader )` Remove all folowers from a leader Remove all folowers from a leader Parameters `$leader`
`public str[]`	# `getMutes( )` Returns the list of muted players Returns the list of muted players Returns str[]
`public`	# `setMute( pocketmine\Player $player, boolean $mode )` Mute/UnMute a player Mute/UnMute a player Parameters `$player` `$mode` true is muted, false is unmuted
`public boolean`	# `getMute( pocketmine\Player $player )` Returns a player mute status Returns a player mute status Parameters `$player` Returns boolean
`public`	# `fileReport( pocketmine\command\CommandSender $c, str $report )` File a report File a report Parameters `$c` `$report`
`public boolean`	# `isReOp( pocketmine\Player $target )` Return player's reop status Return player's reop status Parameters `$target` Returns boolean
`public`	# `reopPlayer( pocketmine\Player $target )` Toggle player's reop Toggle player's reop Parameters `$target`
`public boolean`	# `isShielded( pocketmine\Player $target )` Return player's shield status Return player's shield status Parameters `$target` Returns boolean
`public`	# `setShield( pocketmine\Player $target, boolean $mode )` Turn on/off shields Turn on/off shields Parameters `$target` `$mode` true is shielded, false is not
`public boolean`	# `hasPlenty( pocketmine\Player $target )` Return player's plenty status Return player's plenty status Parameters `$target` Returns boolean
`public`	# `setPlenty( pocketmine\Player $target, boolean $mode )` Turn on/off plenty Turn on/off plenty Parameters `$target` `$mode` true is shielded, false is not
`public`	# `slay( pocketmine\Player $victim, str $msg = "" )` Kills a player with optional message Kills a player with optional message Parameters `$victim` `$msg`
`public`	# `tpSpawn( pocketmine\Player $player )` Teleport a player to world spawn Teleport a player to world spawn Parameters `$player`
`public false\|str`	# `getServiceMode( )` Return the current service mode status Return the current service mode status Returns false\|str
`public`	# `setServiceMode( str $msg )` Change the service mode Change the service mode Parameters `$msg`
`public`	# `unsetServiceMode( )` Exists service mode Exists service mode
`public`	# `summonPlayer( pocketmine\Player $summoner, pocketmine\Player $victim )` Teleport a player to the summoner's vicinity Teleport a player to the summoner's vicinity Parameters `$summoner` `$victim`
`public`	# `dismissPlayer( pocketmine\Player $summoner, pocketmine\Player $victim )` Dismiss a previously summoned player Dismiss a previously summoned player Parameters `$summoner` `$victim`
`public`	# `dismissAll( pocketmine\Player $summoner )` Dismiss all summoned players Dismiss all summoned players Parameters `$summoner`
`public`	# `throwPlayer( pocketmine\Player $victim )` Throw player up in the air. Throw player up in the air. Parameters `$victim`
`public`	# `pushTp( pocketmine\Player $player )` Save position to stack Save position to stack Parameters `$player`
`public`	# `popTp( pocketmine\Player $player )` Restore position from stack Restore position from stack Parameters `$player`
`public`	# `TpAsk( pocketmine\Player $a, pocketmine\Player $b )`
`public`	# `TpHere( pocketmine\Player $a, pocketmine\Player $b )`
`public`	# `TpDecline( pocketmine\Player $a, pocketmine\Player $b )`
`public`	# `TpAccept( pocketmine\Player $a, pocketmine\Player $b )`
`public`	# `getHome( pocketmine\IPlayer $player, pocketmine\level\Level $level )` Get the player's home on the provided level. Get the player's home on the provided level. Parameters `$player` `$level`
`public`	# `setHome( pocketmine\IPlayer $player, pocketmine\level\Position $pos )` Set the player's home in the level provided in $pos Set the player's home in the level provided in $pos Parameters `$player` `$pos`
`public`	# `delHome( pocketmine\IPlayer $player, pocketmine\level\Level $level )` Delete the player's home on the provided level. Delete the player's home on the provided level. Parameters `$player` `$level`
`public str[]`	# `getWarps( )` Return a list of warps Return a list of warps Returns str[]
`public pocketmine\level\Position`	# `getWarp( str $name )` Return a warp definiton or null Return a warp definiton or null Parameters `$name` Returns pocketmine\level\Position
`public boolean`	# `setWarp( str $name, pocketmine\level\Position $pos )` Save a warp Save a warp Parameters `$name` `$pos` Returns boolean true on succes, false on failure
`public boolean`	# `delWarp( str $name )` Delete a warp Delete a warp Parameters `$name` Returns boolean true on succes, false on failure
`public SpySession`	# `getSpySession( )` Get SpySession object Get SpySession object Returns SpySession
`public`	# `getServerIds( )` Get server ids Get server ids
`public boolean`	# `addServer( str $id, array $attrs )` Add Server Add Server Parameters `$id` Server Id `$attrs` Server attributes Returns boolean true on success, false on error
`public boolean`	# `removeServer( str $id )` Remove Server Remove Server Parameters `$id` Server Id Returns boolean true on success, false on error
`public array`	# `getServer( str $id )` Get Server attributes Get Server attributes Parameters `$id` Server Id Returns array attributes
`public mixed`	# `getServerAttr( str $id, str $attr, mixed $default = null )` Get Server attribute Get Server attribute Parameters `$id` Server Id `$attr` attribute to get `$default` value to return if tag is not found Returns mixed
`public boolean`	# `addQueryData( str $id, str $tag, mixed $attrs )` Parameters `$id` Server Id `$tag` tag `$attrs` Server attributes Returns boolean true on success, false on error
`public boolean`	# `delQueryData( str $id, null\|str $tag = null )` Remove Server query data Remove Server query data Parameters `$id` Server Id `$tag` data tag Returns boolean true on success, false on error
`public array\|null`	# `getQueryData( str $id, null\|str $tag = null, mixed $default = null )` Get Query data Get Query data Parameters `$id` Server Id `$tag` `$default` default value to return if data is not found Returns array\|null

Properties summary
`protected`	`$plugin`	#
`protected`	`$vars`	#
`protected`	`$interp`	#

Namespaces

Classes

Class GrabBag

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters