Summary: Methods | [Expand All]
public interface

SampObjectStore

net.gtaun.shoebill.SampObjectStore
Known Indirect Subclasses

Class Overview

SA-MP object interface, managing all SA-MP objects that exist.

Summary

Public Methods
abstract Actor getActor(int id)
Get the actor with a specific id
abstract int getActorPoolSize()
Gets the pool size of the actors
abstract Collection<Actor> getActors()
Get the collection of actors (CreateActor) which exist.
abstract DialogId getDialog(int id)
Get Dialog instance with id.
abstract Collection<DialogId> getDialogIds()
Get the collection of the dialogs that exist.
abstract Collection<Player> getHumanPlayers()
Get the collection of the online human players.
abstract Label getLabel(int id)
Get Label instance with id.
abstract Collection<Label> getLabels()
Get the collection of the labels that exist.
abstract Menu getMenu(int id)
Get Menu instance with id.
abstract Collection<Menu> getMenus()
Get the collection of the menus that exist.
abstract Collection<Player> getNpcPlayers()
Get the collection of the online NPC players.
abstract SampObject getObject(int id)
Get SampObject instance with id.
abstract Collection<SampObject> getObjects()
Get the collection of the objects that exist.
abstract Pickup getPickup(int id)
Get Pickup instance with id.
abstract Collection<Pickup> getPickups()
Get the collection of the pickups that exist.
abstract Player getPlayer(int id)
Get Player instance with id.
abstract Player getPlayer(String name)
Get Player instance with name.
abstract Collection<SpawnInfo> getPlayerClasses()
Get the collection of the player classes (AddPlayerClass) which exist.
abstract PlayerLabel getPlayerLabel(Player player, int id)
Get PlayerLabel instance with id.
abstract Collection<PlayerLabel> getPlayerLabels(Player player)
Get the collection of the PlayerLabels that exist.
abstract PlayerObject getPlayerObject(Player player, int id)
Get PlayerObject instance with id.
abstract Collection<PlayerObject> getPlayerObjects(Player player)
Get the collection of the PlayerObjects that exist.
abstract int getPlayerPoolSize()
Gets the pool size of the players
abstract PlayerTextdraw getPlayerTextdraw(Player player, int id)
Get PlayerTextdraw instance with id.
abstract Collection<PlayerTextdraw> getPlayerTextdraws(Player player)
Get the collection of the player textdraws that exist.
abstract Collection<Player> getPlayers()
Get the collection of the online players.
abstract Server getServer()
Get Server instance.
abstract Textdraw getTextdraw(int id)
Get Textdraw instance with id.
abstract Collection<Textdraw> getTextdraws()
Get the collection of the textdraws that exist.
abstract Vehicle getVehicle(int id)
Get vehicle instance with id.
abstract int getVehiclePoolSize()
Gets the pool size of the vehicles.
abstract Collection<Vehicle> getVehicles()
Get the collection of the vehicles that exist.
abstract World getWorld()
Get World instance.
abstract Zone getZone(int id)
Get Zone instance with id.
abstract Collection<Zone> getZones()
Get the collection of the zones that exist.

Public Methods

public abstract Actor getActor (int id)

Get the actor with a specific id

Parameters
id The actor id
Returns
  • Found actor (null is not found)

public abstract int getActorPoolSize ()

Gets the pool size of the actors

Returns
  • Actor's poolsize

public abstract Collection<Actor> getActors ()

Get the collection of actors (CreateActor) which exist.

Returns
  • Collection of Actors

public abstract DialogId getDialog (int id)

Get Dialog instance with id.

Parameters
id ID of Dialog.
Returns
  • Dialog instance. If not exist, then it return null.

public abstract Collection<DialogId> getDialogIds ()

Get the collection of the dialogs that exist.

Returns
  • Collection of Dialogs.

public abstract Collection<Player> getHumanPlayers ()

Get the collection of the online human players.

Returns
  • Collection of human Players.

public abstract Label getLabel (int id)

Get Label instance with id.

Parameters
id ID of Label.
Returns
  • Label instance. If not exist, then it return null.

public abstract Collection<Label> getLabels ()

Get the collection of the labels that exist.

Returns
  • Collection of Labels.

public abstract Menu getMenu (int id)

Get Menu instance with id.

Parameters
id ID of Menu.
Returns
  • Menu instance. If not exist, then it return null.

public abstract Collection<Menu> getMenus ()

Get the collection of the menus that exist.

Returns
  • Collection of Menus.

public abstract Collection<Player> getNpcPlayers ()

Get the collection of the online NPC players.

Returns
  • Collection of NPC Players.

public abstract SampObject getObject (int id)

Get SampObject instance with id.

Parameters
id ID of Object.
Returns
  • SampObject instance. If not exist, then it return null.

public abstract Collection<SampObject> getObjects ()

Get the collection of the objects that exist.

Returns
  • Collection of Objects.

public abstract Pickup getPickup (int id)

Get Pickup instance with id.

Parameters
id ID of Pickup.
Returns
  • Pickup instance. If not exist, then it return null.

public abstract Collection<Pickup> getPickups ()

Get the collection of the pickups that exist.

Returns
  • Collection of Pickups.

public abstract Player getPlayer (int id)

Get Player instance with id.

Parameters
id ID of Player.
Returns
  • Player instance. If not exist, then it return null.

public abstract Player getPlayer (String name)

Get Player instance with name.

Parameters
name name of Player.
Returns
  • Player instance. If not exist, then it return null.

public abstract Collection<SpawnInfo> getPlayerClasses ()

Get the collection of the player classes (AddPlayerClass) which exist.

Returns
  • Collection of PlayerClasses.

public abstract PlayerLabel getPlayerLabel (Player player, int id)

Get PlayerLabel instance with id.

Parameters
player Player instance.
id ID of PlayerLabel.
Returns
  • PlayerLabel instance. If not exist, then it return null.

public abstract Collection<PlayerLabel> getPlayerLabels (Player player)

Get the collection of the PlayerLabels that exist.

Parameters
player Player instance.
Returns
  • Collection of PlayerLabels.

public abstract PlayerObject getPlayerObject (Player player, int id)

Get PlayerObject instance with id.

Parameters
player Player instance.
id ID of PlayerObject.
Returns
  • PlayerObject instance. If not exist, then it return null.

public abstract Collection<PlayerObject> getPlayerObjects (Player player)

Get the collection of the PlayerObjects that exist.

Parameters
player Player instance.
Returns
  • Collection of PlayerObjects.

public abstract int getPlayerPoolSize ()

Gets the pool size of the players

Returns
  • Player's poolsize

public abstract PlayerTextdraw getPlayerTextdraw (Player player, int id)

Get PlayerTextdraw instance with id.

Parameters
player Player instance.
id ID of PlayerTextdraw.
Returns
  • PlayerTextdraw instance. If not exist, then it return null.

public abstract Collection<PlayerTextdraw> getPlayerTextdraws (Player player)

Get the collection of the player textdraws that exist.

Parameters
player Player instance.
Returns
  • Collection of PlayerTextdraws.

public abstract Collection<Player> getPlayers ()

Get the collection of the online players.

Returns
  • Collection of Players.

public abstract Server getServer ()

Get Server instance.

Returns
  • Server instance.

public abstract Textdraw getTextdraw (int id)

Get Textdraw instance with id.

Parameters
id ID of Textdraw.
Returns
  • Textdraw instance. If not exist, then it return null.

public abstract Collection<Textdraw> getTextdraws ()

Get the collection of the textdraws that exist.

Returns
  • Collection of Textdraws.

public abstract Vehicle getVehicle (int id)

Get vehicle instance with id.

Parameters
id ID of Vehicle.
Returns
  • Vehicle instance. If not exist, then it return null.

public abstract int getVehiclePoolSize ()

Gets the pool size of the vehicles.

Returns
  • Vehicle's poolsize

public abstract Collection<Vehicle> getVehicles ()

Get the collection of the vehicles that exist.

Returns
  • Collection of Vehicles.

public abstract World getWorld ()

Get World instance.

Returns
  • World instance.

public abstract Zone getZone (int id)

Get Zone instance with id.

Parameters
id ID of Zone.
Returns
  • Zone instance. If not exist, then it return null.

public abstract Collection<Zone> getZones ()

Get the collection of the zones that exist.

Returns
  • Collection of Zones.