public interface

Player

implements Proxyable<T>
net.gtaun.shoebill.object.Player

Summary

Constants
int INVALID_ID
int MAX_CHATBUBBLE_LENGTH
int MAX_NAME_LENGTH
int NO_TEAM
Public Methods
abstract void applyAnimation(String animlib, String animname, float delta, int loop, int lockX, int lockY, int freeze, int time, int forcesync)
Applys an Animation to the Player.
abstract void attachCameraTo(PlayerObject object)
Attaches the Camera to a PlayerObject
abstract void attachCameraTo(SampObject object)
Attaches the Camera to a object.
abstract void ban()
Bans the player, and closes the connection.
abstract void ban(String reason)
Bans the player with a reasion, and closes the connection.
abstract void cancelDialog()
Cancels the current Dialog.
abstract void cancelEdit()
Cancels the editing modus.
abstract void cancelSelectTextDraw()
Cancels the Textdraw selection.
abstract void clearAnimations(int forcesync)
Clears all animations.
abstract static void connectNPC(String name, String script)
abstract void createExplosion(Radius pos, int type)
abstract void createExplosion(float x, float y, float z, int type, float radius)
abstract void createExplosion(Vector3D pos, int type, float radius)
abstract boolean deleteVar(String name)
abstract void disableCheckpoint()
Disables the Checkpoint
abstract void disableRaceCheckpoint()
Disables the Race Checkpoint
abstract void disableRemoteVehicleCollisions(boolean disable)
Sets if the vehicle collision should be disabled
abstract boolean editObject(SampObject object)
Starts editing an SampObject.
abstract boolean editPlayerObject(PlayerObject object)
Starts editing an PlayerObject
abstract void enablePlayerCameraTarget(boolean enable)
Sets if the CameraTarget-Function should be enabled (extra bandwith)
abstract void enableStuntBonus(boolean enabled)
Toggles the Stuntbonus
abstract void forceClassSelection()
Forces Player to reselect his character.
abstract static void gameTextToAll(int time, int style, String text)
abstract static void gameTextToAll(int time, int style, String format, Object... args)
abstract static Player get(int id)
Gets a Player by its Id
abstract static Collection<Player> get()
abstract static Player get(String name)
Gets a Player by its Name
abstract Player getAimedTarget()
Gets the aimed Target.
abstract float getAngle()
abstract int getAnimationIndex()
Gets the AnimationIndex of the current Animation.
abstract WeaponModel getArmedWeapon()
Gets the current armed Weapon.
abstract int getArmedWeaponAmmo()
Gets the Ammo of the armed Weapon.
abstract float getArmour()
Gets the Armour of the Player
abstract PlayerAttach getAttach()
Gets the Objects attached on the Player
abstract static Player getByNameOrId(String nameOrId)
Gets a Player by its name or its Id
abstract static Player getByPartOfName(String partOfName)
Gets a Player or npc by a part of his name
abstract int getBytesReceived()
abstract int getBytesSent()
abstract float getCameraAspectRatio()
abstract Vector3D getCameraFrontVector()
Gets the Front Vector of the Camera
abstract int getCameraMode()
Gets the CameraMode of the Player
abstract Vector3D getCameraPosition()
Gets the Camera Position of the Player.
abstract Actor getCameraTargetActor()
Returns the player's targeted actor (null if none) You need to call enablePlayerCameraTarget() to use this function
abstract SampObject getCameraTargetObject()
Returns the player's targeted object (null if none) You need to call enablePlayerCameraTarget() to use this function
abstract Player getCameraTargetPlayer()
Returns the player's targeted player (null if none) You need to call enablePlayerCameraTarget() to use this function
abstract Vehicle getCameraTargetVehicle()
Returns the player's targeted vehicle (null if none) You need to call enablePlayerCameraTarget() to use this function
abstract float getCameraZoom()
abstract Checkpoint getCheckpoint()
Gets the current active Checkpoint.
abstract int getCodepage()
Gets the Codepage of the Player.
abstract Color getColor()
Gets the Color of the Player.
abstract int getConnectedTime()
abstract int getConnectionStatus()
abstract Menu getCurrentMenu()
Gets the currently opened Menu.
abstract DialogId getDialog()
Gets the Dialogid of the opened Dialog.
abstract int getDrunkLevel()
Gets the Drunklevel of the Player.
abstract FightStyle getFightStyle()
Gets the Fightstyle of the Player.
abstract float getHealth()
Gets the Health of the Player
abstract static Collection<Player> getHumans()
Get the collection of the online human players.
abstract int getId()
Gets the Id of the Player
abstract String getIp()
Gets the IP-Address of the Player.
abstract String getIpPort()
abstract PlayerKeyState getKeyState()
Gets the current KeyState
abstract Vector3D getLastShotHitPosition()
abstract Vector3D getLastShotOrigin()
abstract AngledLocation getLocation()
Gets the Location of the Player
abstract LocationZone getMainZoneName()
Gets the zone name where the player is located in.
abstract PlayerMapIcon getMapIcon()
Gets the Map Icon
abstract static int getMaxPlayers()
abstract int getMessagesReceived()
abstract int getMessagesRecvPerSecond()
abstract int getMessagesSent()
abstract int getMoney()
Gets the Money of the Player.
abstract String getName()
Gets the name of the Player.
abstract String getNetworkStats()
Gets the Networkstats.
abstract static Collection<Player> getNpcs()
Get the collection of the online NPC players.
abstract float getPacketLossPercent()
abstract int getPing()
Gets the Ping of the Player.
abstract static int getPoolSize()
Gets the player's pool size
abstract RaceCheckpoint getRaceCheckpoint()
Gets the current active Race Checkpoint.
abstract int getScore()
Gets the Score of the Player.
abstract int getSkin()
Gets the Skin of the Player.
abstract SpecialAction getSpecialAction()
Gets the current SpecialAction
abstract Player getSpectatingPlayer()
Gets the Player which the current Player is spectating.
abstract Vehicle getSpectatingVehicle()
Gets the Vehicle which the current Player is spectating.
abstract PlayerState getState()
Gets the PlayerState of the Player
abstract SampObject getSurfingObject()
Gets the Object under the Player, when he is surfing.
abstract Vehicle getSurfingVehicle()
Gets the current Surfing Vehicle.
abstract Actor getTargetActor()
Returns the player's targeted actor (with weapon, null if none)
abstract int getTeam()
Gets the Team of the Player
abstract Time getTime()
Gets the Playertime.
abstract long getUpdateCount()
Gets the Updatecount of the Player.
abstract float getVarFloat(String name)
abstract int getVarInt(String name)
abstract List<String> getVarNames()
abstract String getVarString(String name)
abstract PlayerVarType getVarType(String name)
abstract Vehicle getVehicle()
Gets the current Vehicle
abstract int getVehicleSeat()
Gets the Vehicleseat from the Currentvehicle
abstract Velocity getVelocity()
Gets the Velocity of the Player
abstract String getVersion()
Gets the version of the Players Client.
abstract int getWantedLevel()
Gets the Wantedlevel of the Player.
abstract WeaponData getWeaponData(int slot)
Gets WeaponData by Slotid.
abstract PlayerWeaponSkill getWeaponSkill()
Gets the WeaponSkill of the Player
abstract WeaponState getWeaponState()
Gets the current WeaponState.
abstract int getWeather()
Gets the Weatherid of the Players Weather.
abstract Area getWorldBound()
Gets the Worldbound of the Player
abstract LocationZone getZoneName()
Gets the detailed zone name.
abstract void giveMoney(int money)
Gives Money to the Player.
abstract void giveWeapon(WeaponModel type, int ammo)
Gives the Player a Weapon.
abstract void giveWeapon(WeaponData data)
Gives the Player a Weapon.
abstract void interpolateCameraLookAt(float fromX, float fromY, float fromZ, float toX, float toY, float toZ, int time, CameraCutStyle cut)
Does smooth Camera Lookat Movement from one point, to another.
abstract void interpolateCameraLookAt(Vector3D from, Vector3D to, int time, CameraCutStyle cut)
Does smooth Camera Lookat Movement from one point, to another.
abstract void interpolateCameraPosition(float fromX, float fromY, float fromZ, float toX, float toY, float toZ, int time, CameraCutStyle cut)
Does smooth camera movement from one point, to another
abstract void interpolateCameraPosition(Vector3D from, Vector3D to, int time, CameraCutStyle cut)
Does smooth camera movement from one point, to another
abstract boolean isAdmin()
Checks if Player is logged in as Rcon Admin
abstract boolean isControllable()
Checks if the Player is controllable (Freezed or not).
abstract boolean isInAnyVehicle()
Checks if Player is in any Vehicle.
abstract boolean isInVehicle(Vehicle veh)
Checks if Player is in a specific Vehicle
abstract boolean isNpc()
Checks if the Player is a Npc.
abstract boolean isOnline()
Gets the Onlinestate
abstract boolean isRecording()
Check if the Player is recording.
abstract boolean isSpectating()
Checks if the Player is spectating.
abstract boolean isStreamedIn(Player forPlayer)
Checks if Player is streamed in for a specific other Player.
abstract boolean isStuntBonusEnabled()
Checks if Stuntbonus is enabled for this player.
abstract void kick()
Kicks the player, and closes the connection.
abstract void markerForPlayer(Player player, Color color)
Sets the Color of the Players Marker for a specific other Player.
abstract void playAudioStream(String url, Radius loc)
Starts an audio stream at a location
abstract void playAudioStream(String url, float x, float y, float z, float distance)
Starts an audio stream at a location.
abstract void playAudioStream(String url, Vector3D location, float distance)
Starts an audio stream at a location
abstract void playAudioStream(String url)
Starts an audio stream for the Player
abstract void playCrimeReport(int suspectId, int crimeId)
Plays a crime report for the Player.
abstract void playSound(int sound, float x, float y, float z)
Plays a sound from the library at a specific position.
abstract void playSound(int sound)
Plays a sound from the library.
abstract void playSound(int sound, Vector3D pos)
Plays a sound from the library at a specific position.
abstract void removeBuilding(int modelId, Vector3D pos, float radius)
Removes a building for the Player
abstract void removeBuilding(int modelId, float x, float y, float z, float radius)
Removes a building for the Player
abstract void removeBuilding(int modelId, Radius loc)
Removes a buidling for the Player
abstract void removeFromVehicle()
Removes the Player from the Current Vehicle
abstract void resetWeapons()
Delete all Weapons.
abstract void selectObject()
Starts the selecting Mode.
abstract void selectTextDraw(Color hoverColor)
Starts the textdraw Selection.
abstract void sendChat(Player player, String message)
Sends a message into the Chat of a Player.
abstract void sendChatToAll(String message)
Sends a Message into the Chat of all Players.
abstract void sendDeathMessage(Player killer, Player victim, WeaponModel weapon)
abstract static void sendDeathMessageToAll(Player killer, Player victim, WeaponModel reason)
abstract void sendGameText(int time, int style, String text)
Sends a Gametext to the Player.
abstract void sendGameText(int time, int style, String format, Object... args)
Send as formated Gametext to the Player.
abstract void sendMessage(Color color, String format, Object... args)
Sends a formated Message to the Player.
abstract void sendMessage(String message)
Send a message to the Player with color white.
abstract void sendMessage(Color color, String message)
Send a Message to the Player.
abstract static void sendMessageToAll(Color color, String message)
abstract static void sendMessageToAll(Color color, String format, Object... args)
abstract void setAngle(float angle)
Sets the Angle of the Player.
abstract void setArmedWeapon(WeaponModel model)
abstract void setArmour(float armour)
Sets the Armour of the Player.
abstract void setCameraBehind()
Sets the Camera behind the Player.
abstract void setCameraLookAt(Vector3D lookAt)
Sets the Position where the Camera looks at.
abstract void setCameraLookAt(float x, float y, float z)
Sets the Position where the Camera looks at.
abstract void setCameraLookAt(Vector3D lookAt, CameraCutStyle cut)
Sets the Position where the Camera looks at.
abstract void setCameraLookAt(float x, float y, float z, CameraCutStyle cut)
Sets the Position where the Camera looks at.
abstract void setCameraPosition(Vector3D pos)
Sets the Camera to a specific position.
abstract void setCameraPosition(float x, float y, float z)
Sets the Camera to a specific position.
abstract void setChatBubble(String text, Color color, float drawDistance, int expireTime)
abstract void setCheckpoint(Checkpoint checkpoint)
Sets a Checkpoint for the Player.
abstract void setCodepage(int codepage)
Sets the codepage by Id.
abstract void setColor(Color color)
Sets the Color of the Player on the Map.
abstract void setDrunkLevel(int level)
Sets the Drunklevel of the Player.
abstract void setFightStyle(FightStyle style)
Sets the Fightstyle of the Player.
abstract void setHealth(float health)
Sets the Health of the Player.
abstract void setInterior(int interiorId)
Sets the interior of the Player.
abstract void setLocation(float x, float y, float z)
Sets the Location of the Player.
abstract void setLocation(AngledLocation loc)
Sets the Location of the Player.
abstract void setLocation(Vector3D pos)
Sets the Location of the Player.
abstract void setLocation(Location loc)
Sets the Location of the Player.
abstract void setLocationFindZ(Location loc)
Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.
abstract void setLocationFindZ(AngledLocation loc)
Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.
abstract void setLocationFindZ(float x, float y, float z)
Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.
abstract void setLocationFindZ(Vector3D pos)
Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.
abstract void setMoney(int money)
Sets the Money of the Player.
abstract void setName(String name)
Sets the Name of the Player.
abstract void setRaceCheckpoint(RaceCheckpoint checkpoint)
Sets the Racecheckpoint
abstract void setScore(int score)
Sets the score of the Player.
abstract void setShopName(ShopName shop)
Sets the Shopname for the Player.
abstract void setSkin(int skin)
Sets the Players Skin.
abstract void setSpawnInfo(AngledLocation loc, int skin, int team, WeaponData weapon1, WeaponData weapon2, WeaponData weapon3)
Sets the Spawninfo of the Player.
abstract void setSpawnInfo(Vector3D pos, int interiorId, int worldId, float angle, int skinId, int teamId, WeaponData weapon1, WeaponData weapon2, WeaponData weapon3)
Sets the Spawninfo of the Player.
abstract void setSpawnInfo(float x, float y, float z, int interiorId, int worldId, float angle, int skinId, int teamId, WeaponModel weapon1, int ammo1, WeaponModel weapon2, int ammo2, WeaponModel weapon3, int ammo3)
Sets the Spawninfo of the Player.
abstract void setSpawnInfo(SpawnInfo info)
Sets the Spawninfo of the Player.
abstract void setSpawnInfo(Location loc, float angle, int skinId, int teamId, WeaponData weapon1, WeaponData weapon2, WeaponData weapon3)
Sets the Spawninfo of the Player.
abstract void setSpecialAction(SpecialAction action)
Sets the special Action of the Player
abstract void setTeam(int team)
Sets the Players Team by Id.
abstract void setTime(Time time)
Sets the Playertime.
abstract void setTime(int hour, int minute)
Sets the Playertime.
abstract void setVarFloat(String name, float value)
abstract void setVarInt(String name, int value)
abstract void setVarString(String name, String value)
abstract void setVehicle(Vehicle vehicle, int seat)
Sets the current Vehicle of the Player.
abstract void setVehicle(Vehicle vehicle)
Sets the current Vehicle of the Player.
abstract void setVelocity(Vector3D vel)
Sets the velocity of the Player.
abstract void setWantedLevel(int level)
Sets the Wantedlevel of the Player
abstract void setWeaponAmmo(WeaponModel weapon, int ammo)
Sets the Ammo of a specific Weapon by Id.
abstract void setWeather(int weatherId)
Sets the Weather for the Player.
abstract void setWorld(int worldId)
Sets the virtual World of the Player.
abstract void setWorldBound(Area bound)
Sets the Worldboundries for the Player.
abstract void showDialog(DialogId dialog, DialogStyle style, String caption, String text, String button1, String button2)
Shows a dialog for the Player
abstract void showNameTagForPlayer(Player player, boolean show)
Sets if Players Nametag can be seen for an other player.
abstract void spawn()
Spawns the Player, when the SpawnInfo is set.
abstract void spectate(Player player, SpectateMode mode)
Sets the spectating Player.
abstract void spectate(Vehicle veh, SpectateMode mode)
Sets the spectating Vehicle
abstract void startRecord(RecordType type, String recordName)
Starts the recording.
abstract void stopAudioStream()
Stops the audio Stream.
abstract void stopRecord()
Stops the recording
abstract void toggleClock(boolean toggle)
Toggles Clock
abstract void toggleControllable(boolean toggle)
Sets the Controllability of the Player.
abstract void toggleSpectating(boolean toggle)
Toggles the Spectating Mode
[Expand]
Inherited Methods
From interface net.gtaun.shoebill.object.Proxyable

Constants

public static final int INVALID_ID

Constant Value: 65535 (0x0000ffff)

public static final int MAX_CHATBUBBLE_LENGTH

Constant Value: 144 (0x00000090)

public static final int MAX_NAME_LENGTH

Constant Value: 24 (0x00000018)

public static final int NO_TEAM

Constant Value: 255 (0x000000ff)

Public Methods

public abstract void applyAnimation (String animlib, String animname, float delta, int loop, int lockX, int lockY, int freeze, int time, int forcesync)

Applys an Animation to the Player.

Parameters
animlib Location in Animlib
animname Name of Animation
delta Speed of the Animation
loop Looping
lockX Sets Player back to original X after Animation completed
lockY Sets Player back to original Y after Animation completed
freeze Freezes the Player while the Animation is running
time How long its getting played
forcesync Sync Animation with all Player

public abstract void attachCameraTo (PlayerObject object)

Attaches the Camera to a PlayerObject

Parameters
object PlayerObject

public abstract void attachCameraTo (SampObject object)

Attaches the Camera to a object.

Parameters
object Object

public abstract void ban ()

Bans the player, and closes the connection.

public abstract void ban (String reason)

Bans the player with a reasion, and closes the connection.

public abstract void cancelDialog ()

Cancels the current Dialog.

public abstract void cancelEdit ()

Cancels the editing modus.

public abstract void cancelSelectTextDraw ()

Cancels the Textdraw selection.

public abstract void clearAnimations (int forcesync)

Clears all animations.

Parameters
forcesync Sync Animation with all Player

public static abstract void connectNPC (String name, String script)

public abstract void createExplosion (Radius pos, int type)

public abstract void createExplosion (float x, float y, float z, int type, float radius)

public abstract void createExplosion (Vector3D pos, int type, float radius)

public abstract boolean deleteVar (String name)

public abstract void disableCheckpoint ()

Disables the Checkpoint

public abstract void disableRaceCheckpoint ()

Disables the Race Checkpoint

public abstract void disableRemoteVehicleCollisions (boolean disable)

Sets if the vehicle collision should be disabled

Parameters
disable If the collision should be disabled

public abstract boolean editObject (SampObject object)

Starts editing an SampObject.

Parameters
object Object to edit
Returns
  • boolean(Success or failed)

public abstract boolean editPlayerObject (PlayerObject object)

Starts editing an PlayerObject

Parameters
object PlayerObject to edit
Returns
  • boolean(Success or failed)

public abstract void enablePlayerCameraTarget (boolean enable)

Sets if the CameraTarget-Function should be enabled (extra bandwith)

Parameters
enable If the function should be enabled

public abstract void enableStuntBonus (boolean enabled)

Toggles the Stuntbonus

Parameters
enabled toggle

public abstract void forceClassSelection ()

Forces Player to reselect his character.

public static abstract void gameTextToAll (int time, int style, String text)

public static abstract void gameTextToAll (int time, int style, String format, Object... args)

public static abstract Player get (int id)

Gets a Player by its Id

Parameters
id Id of the Player
Returns
  • The found Player

public static abstract Collection<Player> get ()

public static abstract Player get (String name)

Gets a Player by its Name

Parameters
name Name of the Player
Returns
  • The found Player

public abstract Player getAimedTarget ()

Gets the aimed Target.

Returns
  • Aimed Player

public abstract float getAngle ()

public abstract int getAnimationIndex ()

Gets the AnimationIndex of the current Animation.

Returns
  • AnimationIndex

public abstract WeaponModel getArmedWeapon ()

Gets the current armed Weapon.

Returns
  • The Weaponmodel of the current armed Weapon.

public abstract int getArmedWeaponAmmo ()

Gets the Ammo of the armed Weapon.

Returns
  • The Ammo of the armed Weapon

public abstract float getArmour ()

Gets the Armour of the Player

Returns
  • Armour of the Player

public abstract PlayerAttach getAttach ()

Gets the Objects attached on the Player

Returns
  • The PlayerAttach Object

public static abstract Player getByNameOrId (String nameOrId)

Gets a Player by its name or its Id

Parameters
nameOrId The Name or Id
Returns
  • The found Player

public static abstract Player getByPartOfName (String partOfName)

Gets a Player or npc by a part of his name

Parameters
partOfName Part of the name
Returns
  • The found player, or else null

public abstract int getBytesReceived ()

public abstract int getBytesSent ()

public abstract float getCameraAspectRatio ()

public abstract Vector3D getCameraFrontVector ()

Gets the Front Vector of the Camera

Returns
  • Front Vector

public abstract int getCameraMode ()

Gets the CameraMode of the Player

Returns
  • CameraMode from Player

public abstract Vector3D getCameraPosition ()

Gets the Camera Position of the Player.

Returns
  • Camera Position

public abstract Actor getCameraTargetActor ()

Returns the player's targeted actor (null if none) You need to call enablePlayerCameraTarget() to use this function

Returns
  • Target actor

public abstract SampObject getCameraTargetObject ()

Returns the player's targeted object (null if none) You need to call enablePlayerCameraTarget() to use this function

Returns
  • Target object

public abstract Player getCameraTargetPlayer ()

Returns the player's targeted player (null if none) You need to call enablePlayerCameraTarget() to use this function

Returns
  • Target player

public abstract Vehicle getCameraTargetVehicle ()

Returns the player's targeted vehicle (null if none) You need to call enablePlayerCameraTarget() to use this function

Returns
  • Target vehicle

public abstract float getCameraZoom ()

public abstract Checkpoint getCheckpoint ()

Gets the current active Checkpoint.

Returns
  • Current Checkpoint

public abstract int getCodepage ()

Gets the Codepage of the Player.

Returns
  • The Codepage

public abstract Color getColor ()

Gets the Color of the Player.

Returns
  • The Color

public abstract int getConnectedTime ()

public abstract int getConnectionStatus ()

public abstract Menu getCurrentMenu ()

Gets the currently opened Menu.

Returns
  • Opened Menu

public abstract DialogId getDialog ()

Gets the Dialogid of the opened Dialog.

Returns
  • The Id of the current Dialog

public abstract int getDrunkLevel ()

Gets the Drunklevel of the Player.

Returns
  • Players Drunklevel

public abstract FightStyle getFightStyle ()

Gets the Fightstyle of the Player.

Returns
  • Fightstyle from Player

public abstract float getHealth ()

Gets the Health of the Player

Returns
  • Health of the Player

public static abstract Collection<Player> getHumans ()

Get the collection of the online human players.

Returns
  • Collection of human Players.

public abstract int getId ()

Gets the Id of the Player

Returns
  • Playerid

public abstract String getIp ()

Gets the IP-Address of the Player.

Returns
  • The IP-Address

public abstract String getIpPort ()

public abstract PlayerKeyState getKeyState ()

Gets the current KeyState

Returns
  • Current Keystate

public abstract Vector3D getLastShotHitPosition ()

public abstract Vector3D getLastShotOrigin ()

public abstract AngledLocation getLocation ()

Gets the Location of the Player

Returns
  • Location

public abstract LocationZone getMainZoneName ()

Gets the zone name where the player is located in. e.g. Las Venturas

Returns
  • The zone name

public abstract PlayerMapIcon getMapIcon ()

Gets the Map Icon

Returns
  • Players Map Icon

public static abstract int getMaxPlayers ()

public abstract int getMessagesReceived ()

public abstract int getMessagesRecvPerSecond ()

public abstract int getMessagesSent ()

public abstract int getMoney ()

Gets the Money of the Player.

Returns
  • Money of the Player

public abstract String getName ()

Gets the name of the Player.

Returns
  • The Name

public abstract String getNetworkStats ()

Gets the Networkstats.

Returns
  • Networkstats

public static abstract Collection<Player> getNpcs ()

Get the collection of the online NPC players.

Returns
  • Collection of NPC Players.

public abstract float getPacketLossPercent ()

public abstract int getPing ()

Gets the Ping of the Player.

Returns
  • The Ping

public static abstract int getPoolSize ()

Gets the player's pool size

Returns
  • Player's pool size

public abstract RaceCheckpoint getRaceCheckpoint ()

Gets the current active Race Checkpoint.

Returns
  • Current Race Checkpoint

public abstract int getScore ()

Gets the Score of the Player.

Returns
  • Score of the Player

public abstract int getSkin ()

Gets the Skin of the Player.

Returns
  • The Skin

public abstract SpecialAction getSpecialAction ()

Gets the current SpecialAction

Returns
  • Current SpecialAction

public abstract Player getSpectatingPlayer ()

Gets the Player which the current Player is spectating.

Returns
  • Player which is getting spectated

public abstract Vehicle getSpectatingVehicle ()

Gets the Vehicle which the current Player is spectating.

Returns
  • Vehicle which is gettings spectated.

public abstract PlayerState getState ()

Gets the PlayerState of the Player

Returns
  • Current PlayerState

public abstract SampObject getSurfingObject ()

Gets the Object under the Player, when he is surfing.

Returns
  • Surfing SampObject

public abstract Vehicle getSurfingVehicle ()

Gets the current Surfing Vehicle. If there is none, it will return null.

Returns
  • Surfing Vehicle.

public abstract Actor getTargetActor ()

Returns the player's targeted actor (with weapon, null if none)

Returns
  • Targeted actor (with weapon, not with camera)

public abstract int getTeam ()

Gets the Team of the Player

Returns
  • The Team

public abstract Time getTime ()

Gets the Playertime.

Returns
  • Time

public abstract long getUpdateCount ()

Gets the Updatecount of the Player.

Returns
  • The Updatecount

public abstract float getVarFloat (String name)

public abstract int getVarInt (String name)

public abstract List<String> getVarNames ()

public abstract String getVarString (String name)

public abstract PlayerVarType getVarType (String name)

public abstract Vehicle getVehicle ()

Gets the current Vehicle

Returns
  • Current Vehhicle

public abstract int getVehicleSeat ()

Gets the Vehicleseat from the Currentvehicle

Returns
  • SeatId

public abstract Velocity getVelocity ()

Gets the Velocity of the Player

Returns
  • Velocity

public abstract String getVersion ()

Gets the version of the Players Client.

Returns
  • SAMP-Client Version

public abstract int getWantedLevel ()

Gets the Wantedlevel of the Player.

Returns
  • The Wantedlevel

public abstract WeaponData getWeaponData (int slot)

Gets WeaponData by Slotid.

Parameters
slot Slotid
Returns
  • The WeaponData

public abstract PlayerWeaponSkill getWeaponSkill ()

Gets the WeaponSkill of the Player

Returns
  • The WeaponSkill

public abstract WeaponState getWeaponState ()

Gets the current WeaponState.

Returns
  • The WeaponState

public abstract int getWeather ()

Gets the Weatherid of the Players Weather.

Returns
  • Weatherid of Players Weather

public abstract Area getWorldBound ()

Gets the Worldbound of the Player

Returns
  • Worldbound

public abstract LocationZone getZoneName ()

Gets the detailed zone name. e.g. The Strip

Returns
  • The detailed zone name

public abstract void giveMoney (int money)

Gives Money to the Player.

Parameters
money Amount of Money to give

public abstract void giveWeapon (WeaponModel type, int ammo)

Gives the Player a Weapon.

Parameters
type Weapontype
ammo Ammount of Ammo

public abstract void giveWeapon (WeaponData data)

Gives the Player a Weapon.

Parameters
data Weapondata

public abstract void interpolateCameraLookAt (float fromX, float fromY, float fromZ, float toX, float toY, float toZ, int time, CameraCutStyle cut)

Does smooth Camera Lookat Movement from one point, to another.

Parameters
fromX Start X-Position
fromY Start Y-Position
fromZ Start Z-Positon
toX End X-Position
toY End Y-Position
toZ End Z-Position
time How long it will need
cut Camera Cut

public abstract void interpolateCameraLookAt (Vector3D from, Vector3D to, int time, CameraCutStyle cut)

Does smooth Camera Lookat Movement from one point, to another.

Parameters
from Start Position
to End Position
time How long it will need
cut Camera Cut

public abstract void interpolateCameraPosition (float fromX, float fromY, float fromZ, float toX, float toY, float toZ, int time, CameraCutStyle cut)

Does smooth camera movement from one point, to another

Parameters
fromX Start X-Position
fromY Start Y-Position
fromZ Start Z-Positon
toX End X-Position
toY End Y-Position
toZ End Z-Position
time How long it will need
cut Camera Cut

public abstract void interpolateCameraPosition (Vector3D from, Vector3D to, int time, CameraCutStyle cut)

Does smooth camera movement from one point, to another

Parameters
from Start Position
to End Position
time How long it will need
cut Camera Cut

public abstract boolean isAdmin ()

Checks if Player is logged in as Rcon Admin

Returns
  • boolean(Yes or No)

public abstract boolean isControllable ()

Checks if the Player is controllable (Freezed or not).

Returns
  • The Controllable state

public abstract boolean isInAnyVehicle ()

Checks if Player is in any Vehicle.

Returns
  • boolean(state)

public abstract boolean isInVehicle (Vehicle veh)

Checks if Player is in a specific Vehicle

Parameters
veh Specific Vehicle
Returns
  • boolean(Yes Or No)

public abstract boolean isNpc ()

Checks if the Player is a Npc.

Returns
  • boolean(Yes or No)

public abstract boolean isOnline ()

Gets the Onlinestate

Returns
  • State of the Player

public abstract boolean isRecording ()

Check if the Player is recording.

Returns
  • The Recording state

public abstract boolean isSpectating ()

Checks if the Player is spectating.

Returns
  • The spectating state

public abstract boolean isStreamedIn (Player forPlayer)

Checks if Player is streamed in for a specific other Player.

Parameters
forPlayer Specific Other Player
Returns
  • boolean(Yes or No)

public abstract boolean isStuntBonusEnabled ()

Checks if Stuntbonus is enabled for this player.

Returns
  • The Stuntbonus state

public abstract void kick ()

Kicks the player, and closes the connection.

public abstract void markerForPlayer (Player player, Color color)

Sets the Color of the Players Marker for a specific other Player.

Parameters
player Player to change Map Color
color New Color

public abstract void playAudioStream (String url, Radius loc)

Starts an audio stream at a location

Parameters
url Streamurl
loc Location

public abstract void playAudioStream (String url, float x, float y, float z, float distance)

Starts an audio stream at a location.

Parameters
url Streamurl
x X-Position
y Y-Position
z Z-Position
distance Range, until it can be heard.

public abstract void playAudioStream (String url, Vector3D location, float distance)

Starts an audio stream at a location

Parameters
url Streamurl
location Streamlocation
distance Range, until it can be heard.

public abstract void playAudioStream (String url)

Starts an audio stream for the Player

Parameters
url Streamurl

public abstract void playCrimeReport (int suspectId, int crimeId)

Plays a crime report for the Player.

Parameters
suspectId The suspected Player
crimeId The Crimeid

public abstract void playSound (int sound, float x, float y, float z)

Plays a sound from the library at a specific position.

Parameters
sound Soundid
x X-Position
y Y-Position
z Z-Position

public abstract void playSound (int sound)

Plays a sound from the library.

public abstract void playSound (int sound, Vector3D pos)

Plays a sound from the library at a specific position.

public abstract void removeBuilding (int modelId, Vector3D pos, float radius)

Removes a building for the Player

Parameters
modelId Objectmodelid
pos Position
radius Radius

public abstract void removeBuilding (int modelId, float x, float y, float z, float radius)

Removes a building for the Player

Parameters
modelId Objectmodelid
x X-Position
y Y-Position
z Z-Position
radius Radius

public abstract void removeBuilding (int modelId, Radius loc)

Removes a buidling for the Player

Parameters
modelId Objectmodelid
loc Range

public abstract void removeFromVehicle ()

Removes the Player from the Current Vehicle

public abstract void resetWeapons ()

Delete all Weapons.

public abstract void selectObject ()

Starts the selecting Mode.

public abstract void selectTextDraw (Color hoverColor)

Starts the textdraw Selection.

Parameters
hoverColor Color of textdraw, when player hovers over it.

public abstract void sendChat (Player player, String message)

Sends a message into the Chat of a Player.

Parameters
player Receiver
message Text of the Message

public abstract void sendChatToAll (String message)

Sends a Message into the Chat of all Players.

Parameters
message Text of the Message

public abstract void sendDeathMessage (Player killer, Player victim, WeaponModel weapon)

public static abstract void sendDeathMessageToAll (Player killer, Player victim, WeaponModel reason)

public abstract void sendGameText (int time, int style, String text)

Sends a Gametext to the Player.

Parameters
time Visible Time
style Gametext Style
text Text to display

public abstract void sendGameText (int time, int style, String format, Object... args)

Send as formated Gametext to the Player.

Parameters
time Visible Time
style Gametext Style
format Formated Text of the Message
args Arguments

public abstract void sendMessage (Color color, String format, Object... args)

Sends a formated Message to the Player.

Parameters
color Color of the Message
format Formated Text of the Message
args Arguments

public abstract void sendMessage (String message)

Send a message to the Player with color white.

Parameters
message Text of the Message

public abstract void sendMessage (Color color, String message)

Send a Message to the Player.

Parameters
color Color of the Message
message Text of the Message

public static abstract void sendMessageToAll (Color color, String message)

public static abstract void sendMessageToAll (Color color, String format, Object... args)

public abstract void setAngle (float angle)

Sets the Angle of the Player.

Parameters
angle Angle in degress

public abstract void setArmedWeapon (WeaponModel model)

public abstract void setArmour (float armour)

Sets the Armour of the Player.

Parameters
armour New Armour

public abstract void setCameraBehind ()

Sets the Camera behind the Player.

public abstract void setCameraLookAt (Vector3D lookAt)

Sets the Position where the Camera looks at.

Parameters
lookAt Vector3D-Position

public abstract void setCameraLookAt (float x, float y, float z)

Sets the Position where the Camera looks at.

Parameters
x X-Position
y Y-Position
z Z-Position

public abstract void setCameraLookAt (Vector3D lookAt, CameraCutStyle cut)

Sets the Position where the Camera looks at.

Parameters
lookAt Vector3D-Positoon
cut CutStyle

public abstract void setCameraLookAt (float x, float y, float z, CameraCutStyle cut)

Sets the Position where the Camera looks at.

Parameters
x X-Position
y Y-Position
z Z-Position
cut CutStyle

public abstract void setCameraPosition (Vector3D pos)

Sets the Camera to a specific position.

Parameters
pos Camera Position

public abstract void setCameraPosition (float x, float y, float z)

Sets the Camera to a specific position.

Parameters
x X-Position
y Y-Position
z Z-Position

public abstract void setChatBubble (String text, Color color, float drawDistance, int expireTime)

public abstract void setCheckpoint (Checkpoint checkpoint)

Sets a Checkpoint for the Player.

Parameters
checkpoint Checkpoint

public abstract void setCodepage (int codepage)

Sets the codepage by Id.

Parameters
codepage Id of the Codepage

public abstract void setColor (Color color)

Sets the Color of the Player on the Map.

Parameters
color New Color

public abstract void setDrunkLevel (int level)

Sets the Drunklevel of the Player.

Parameters
level New Drunklevel

public abstract void setFightStyle (FightStyle style)

Sets the Fightstyle of the Player.

Parameters
style New Fightstyle

public abstract void setHealth (float health)

Sets the Health of the Player.

Parameters
health New Health

public abstract void setInterior (int interiorId)

Sets the interior of the Player.

Parameters
interiorId New Interiorid

public abstract void setLocation (float x, float y, float z)

Sets the Location of the Player.

Parameters
x X-Position
y Y-Position
z Z-Position

public abstract void setLocation (AngledLocation loc)

Sets the Location of the Player.

Parameters
loc AngledLocation

public abstract void setLocation (Vector3D pos)

Sets the Location of the Player.

Parameters
pos Vector3D-Position

public abstract void setLocation (Location loc)

Sets the Location of the Player.

Parameters
loc Location

public abstract void setLocationFindZ (Location loc)

Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.

Parameters
loc Location

public abstract void setLocationFindZ (AngledLocation loc)

Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.

Parameters
loc AngledLocation

public abstract void setLocationFindZ (float x, float y, float z)

Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.

Parameters
x X-Position
y Y-Position
z Z-Position

public abstract void setLocationFindZ (Vector3D pos)

Sets the Location of the Player, and then sets the Z-Position to the nearest Ground.

Parameters
pos Vector3D-Position

public abstract void setMoney (int money)

Sets the Money of the Player.

Parameters
money New Money

public abstract void setName (String name)

Sets the Name of the Player.

Parameters
name New name
Throws
IllegalArgumentException
IllegalLengthException
AlreadyExistException
IllegalArgumentException
IllegalLengthException

public abstract void setRaceCheckpoint (RaceCheckpoint checkpoint)

Sets the Racecheckpoint

Parameters
checkpoint Racecheckpoint

public abstract void setScore (int score)

Sets the score of the Player.

Parameters
score New Score

public abstract void setShopName (ShopName shop)

Sets the Shopname for the Player.

Parameters
shop Shopname

public abstract void setSkin (int skin)

Sets the Players Skin.

Parameters
skin The SkinId

public abstract void setSpawnInfo (AngledLocation loc, int skin, int team, WeaponData weapon1, WeaponData weapon2, WeaponData weapon3)

Sets the Spawninfo of the Player.

Parameters
loc Spawn-Location
skin The Skin when the Player spawns.
team The Id of the Team
weapon1 WeaponData of first Spawn Weapon.
weapon2 WeaponData of second Spawn Weapon.
weapon3 WeaponData of third Spawn Weapon.

public abstract void setSpawnInfo (Vector3D pos, int interiorId, int worldId, float angle, int skinId, int teamId, WeaponData weapon1, WeaponData weapon2, WeaponData weapon3)

Sets the Spawninfo of the Player.

Parameters
pos Spawn-Position
interiorId Spawn-Interior
worldId Spawn-Worldid
angle Spawn-Angle
skinId The Skin when the Player spawns
teamId The Id of the Team
weapon1 WeaponData of first Spawn Weapon.
weapon2 WeaponData of second Spawn Weapon.
weapon3 WeaponData of third Spawn Weapon.

public abstract void setSpawnInfo (float x, float y, float z, int interiorId, int worldId, float angle, int skinId, int teamId, WeaponModel weapon1, int ammo1, WeaponModel weapon2, int ammo2, WeaponModel weapon3, int ammo3)

Sets the Spawninfo of the Player.

Parameters
x X-Spawn-Position
y Y-Spawn-Position
z Z-Spawn-Position
interiorId Spawn-InteriorId
worldId Spawn-Worldid
angle Spawn-Angle
skinId The Skin when the Player spawns
teamId The Id of the Team
weapon1 First Spawn Weapon
ammo1 Ammo of first Weapon
weapon2 Second Spawn Weapon
ammo2 Ammo of second Weapon
weapon3 Third Spawn Weapon
ammo3 Ammo of third spawn Weapon

public abstract void setSpawnInfo (SpawnInfo info)

Sets the Spawninfo of the Player.

Parameters
info SpawnInfo with all information

public abstract void setSpawnInfo (Location loc, float angle, int skinId, int teamId, WeaponData weapon1, WeaponData weapon2, WeaponData weapon3)

Sets the Spawninfo of the Player.

Parameters
loc Spawn-Location
angle Spawn-Angle
skinId The Skin when the Player spawns
teamId The Id of the Team
weapon1 WeaponData of first Spawn Weapon.
weapon2 WeaponData of second Spawn Weapon.
weapon3 WeaponData of third Spawn Weapon.

public abstract void setSpecialAction (SpecialAction action)

Sets the special Action of the Player

Parameters
action Special Action

public abstract void setTeam (int team)

Sets the Players Team by Id.

Parameters
team The Id of the Team

public abstract void setTime (Time time)

Sets the Playertime.

Parameters
time time

public abstract void setTime (int hour, int minute)

Sets the Playertime.

Parameters
hour hour
minute minute

public abstract void setVarFloat (String name, float value)

public abstract void setVarInt (String name, int value)

public abstract void setVarString (String name, String value)

public abstract void setVehicle (Vehicle vehicle, int seat)

Sets the current Vehicle of the Player.

Parameters
vehicle Vehicle to put the Player in
seat Seat id of the Vehicle

public abstract void setVehicle (Vehicle vehicle)

Sets the current Vehicle of the Player.

Parameters
vehicle Vehicle to put the Player in

public abstract void setVelocity (Vector3D vel)

Sets the velocity of the Player.

Parameters
vel New Velocity

public abstract void setWantedLevel (int level)

Sets the Wantedlevel of the Player

Parameters
level New Wantedlevel

public abstract void setWeaponAmmo (WeaponModel weapon, int ammo)

Sets the Ammo of a specific Weapon by Id.

Parameters
weapon WeaponModel of the Weapon
ammo New Ammo of the Weapon

public abstract void setWeather (int weatherId)

Sets the Weather for the Player.

Parameters
weatherId New Weather

public abstract void setWorld (int worldId)

Sets the virtual World of the Player.

Parameters
worldId New Virtual World

public abstract void setWorldBound (Area bound)

Sets the Worldboundries for the Player.

Parameters
bound Boundries

public abstract void showDialog (DialogId dialog, DialogStyle style, String caption, String text, String button1, String button2)

Shows a dialog for the Player

Parameters
dialog The Dialogid
style The Dialogstyle
caption The Dialogcaption
text Text to display
button1 Button 1 Text
button2 Button 2 Text

public abstract void showNameTagForPlayer (Player player, boolean show)

Sets if Players Nametag can be seen for an other player.

Parameters
player Other Player
show Show

public abstract void spawn ()

Spawns the Player, when the SpawnInfo is set.

public abstract void spectate (Player player, SpectateMode mode)

Sets the spectating Player.

Parameters
player Player to spectate
mode Spectatemode

public abstract void spectate (Vehicle veh, SpectateMode mode)

Sets the spectating Vehicle

Parameters
veh Vehicle to spectate
mode Spectatemode

public abstract void startRecord (RecordType type, String recordName)

Starts the recording.

Parameters
type Recordingtype
recordName Filename

public abstract void stopAudioStream ()

Stops the audio Stream.

public abstract void stopRecord ()

Stops the recording

public abstract void toggleClock (boolean toggle)

Toggles Clock

Parameters
toggle enabled

public abstract void toggleControllable (boolean toggle)

Sets the Controllability of the Player.

Parameters
toggle controllable

public abstract void toggleSpectating (boolean toggle)

Toggles the Spectating Mode

Parameters
toggle toggle