| net.gtaun.shoebill.object.Label |
 Known Indirect Subclasses
|
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | INVALID_ID | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
attach(Vehicle vehicle, float x, float y, float z)
Attaches the Label to a Vehicle
| ||||||||||
| abstract void |
attach(Player player, float x, float y, float z)
Attaches the Label to a Player
| ||||||||||
| abstract void |
attach(Vehicle vehicle, Vector3D offset)
Attaches the Label to a Vehicle
| ||||||||||
| abstract void |
attach(Player player, Vector3D offset)
Attaches the Label to a Player
| ||||||||||
| abstract static Label |
create(String text, Color color, float x, float y, float z, int worldId, float drawDistance, boolean testLOS)
Create a Label with params.
| ||||||||||
| abstract static Label |
create(String text, Color color, Location loc, float drawDistance, boolean testLOS)
Create a Label with params.
| ||||||||||
| abstract static Label |
create(String text, Color color, Vector3D pos, int worldId, float drawDistance, boolean testLOS)
Create a Label with params.
| ||||||||||
| abstract static Label |
get(int id)
Gets a Label by its Id
| ||||||||||
| abstract static Collection<Label> | get() | ||||||||||
| abstract Player |
getAttachedPlayer()
Gets the attached Player.
| ||||||||||
| abstract Vehicle |
getAttachedVehicle()
Gets the attached Vehicle.
| ||||||||||
| abstract Color |
getColor()
Gets the Color of the Dialog
| ||||||||||
| abstract float |
getDrawDistance()
Gets the draw distance of the Label.
| ||||||||||
| abstract int |
getId()
Gets the Id of the Label
| ||||||||||
| abstract Location |
getLocation()
Gets the Location of the Label
| ||||||||||
| abstract String |
getText()
Gets the Text of the Label
| ||||||||||
| abstract void |
update(Color color, String text)
Updates the Text and Color of the Label
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
net.gtaun.shoebill.object.Destroyable
| |||||||||||
|
From interface
net.gtaun.shoebill.object.Proxyable
| |||||||||||
Constants
public static final int INVALID_ID
Constant Value:
65535
(0x0000ffff)
Public Methods
public abstract void attach (Vehicle vehicle, float x, float y, float z)
Attaches the Label to a Vehicle
Parameters
| vehicle | The Vehicle |
|---|---|
| x | X-Offset |
| y | Y-Offset |
| z | Z-Offset |
public abstract void attach (Player player, float x, float y, float z)
Attaches the Label to a Player
Parameters
| player | The Player |
|---|---|
| x | X-Offset |
| y | Y-Offset |
| z | Z-Offset |
public abstract void attach (Vehicle vehicle, Vector3D offset)
Attaches the Label to a Vehicle
Parameters
| vehicle | The Vehicle |
|---|---|
| offset | The Location |
public abstract void attach (Player player, Vector3D offset)
Attaches the Label to a Player
Parameters
| player | The Player |
|---|---|
| offset | The Location |
public static abstract Label create (String text, Color color, float x, float y, float z, int worldId, float drawDistance, boolean testLOS)
Create a Label with params. If the Creation fails, it will throw a CreationFailedException.
Parameters
| text | The displayed Text. |
|---|---|
| color | The color of the Label. |
| x | X-Pos where the Label should be. |
| y | Y-Pos where the Label should be. |
| z | Z-Pos where the Label should be. |
| worldId | Worldid where the Label should be. |
| drawDistance | The Drawdistance of the Label. |
| testLOS | If the Label can be seen through objects. |
Returns
- The created Label.
Throws
| CreationFailedException |
|---|
public static abstract Label create (String text, Color color, Location loc, float drawDistance, boolean testLOS)
Create a Label with params. If the Creation fails, it will throw a CreationFailedException.
Parameters
| text | The displayed Text. |
|---|---|
| color | The color of the Label. |
| loc | Location where the Label should be. |
| drawDistance | The Drawdistance of the Label. |
| testLOS | If the Label can be seen through objects. |
Returns
- The created Label.
Throws
| CreationFailedException |
|---|
public static abstract Label create (String text, Color color, Vector3D pos, int worldId, float drawDistance, boolean testLOS)
Create a Label with params. If the Creation fails, it will throw a CreationFailedException.
Parameters
| text | The displayed Text. |
|---|---|
| color | The color of the Label. |
| pos | Vector3D-Pos where the Label should be. |
| worldId | Worldid where the Label should be. |
| drawDistance | The Drawdistance of the Label. |
| testLOS | If the Label can be seen through objects. |
Returns
- The created Label.
Throws
| CreationFailedException |
|---|
public static abstract Label get (int id)
Gets a Label by its Id
Parameters
| id | The Id |
|---|
Returns
- The found Label
public abstract Player getAttachedPlayer ()
Gets the attached Player. If there is no, this Function will return null.
Returns
- The attached Player
public abstract Vehicle getAttachedVehicle ()
Gets the attached Vehicle. If there is no, this Function will return null.
Returns
- The attached Vehicle
public abstract float getDrawDistance ()
Gets the draw distance of the Label.
Returns
- The Draw Distance
public abstract int getId ()
Gets the Id of the Label
Returns
- The Id of the Label
public abstract void update (Color color, String text)
Updates the Text and Color of the Label
Parameters
| color | New Color |
|---|---|
| text | New Text |