public
interface
Actor
implements Destroyable| net.gtaun.shoebill.object.Actor |
Class Overview
Created by marvin on 01.05.15 in project shoebill-api. Copyright (c) 2015 Marvin Haschker. All rights reserved.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | INVALID_ACTOR | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
applyAnimation(String animLib, String animName, float animSpeed, boolean loop, boolean lockX, boolean lockY, boolean freeze, int time)
Applies a animation for the actor
| ||||||||||
| abstract void |
clearAnimation()
Clears all animations from the actor
| ||||||||||
| abstract static Actor | create(int modelid, Vector3D position, float angle) | ||||||||||
| abstract static Actor | create(int modelid, float x, float y, float z, float angle) | ||||||||||
| abstract static Actor | create(int modelid, AngledLocation loc) | ||||||||||
| abstract static Actor |
get(int id)
Get a actor by it's id
| ||||||||||
| abstract static Collection<Actor> |
getActors()
Get all actors available
| ||||||||||
| abstract float |
getAngle()
Gets the facing angle of the actor
| ||||||||||
| abstract float |
getHealth()
Get the current health of the actor
| ||||||||||
| abstract int |
getId()
Get the internal id of the actor
| ||||||||||
| abstract AngledLocation |
getLocation()
Gets the location of the actor
| ||||||||||
| abstract int |
getModel()
Gets the model if the actor
| ||||||||||
| abstract static int |
getPoolSize()
Gets the actor's pool size
| ||||||||||
| abstract int |
getVirtualWorld()
Gets the virtual world of the actor
| ||||||||||
| abstract boolean |
isActorStreamedIn(Player player)
Checks if the actor is streamed-in for a specific player
| ||||||||||
| abstract boolean |
isInvulnerable()
Gets the actor's invulnerable state
| ||||||||||
| abstract void |
setAngle(float angle)
Sets the actor's facing angle
| ||||||||||
| abstract void |
setHealth(float health)
Sets the actor's health
| ||||||||||
| abstract void |
setInvulnerable(boolean invulnerable)
Sets the actor's invulnerable state
| ||||||||||
| abstract void |
setLocation(AngledLocation loc)
Sets the actor's location
| ||||||||||
| abstract void |
setLocation(Vector3D pos)
Sets the actor's location
| ||||||||||
| abstract void |
setLocation(Location loc)
Sets the actor's location
| ||||||||||
| abstract void |
setVirtualWorld(int world)
Sets the actor's virtual world
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
net.gtaun.shoebill.object.Destroyable
| |||||||||||
Constants
public static final int INVALID_ACTOR
Constant Value:
65535
(0x0000ffff)
Public Methods
public abstract void applyAnimation (String animLib, String animName, float animSpeed, boolean loop, boolean lockX, boolean lockY, boolean freeze, int time)
Applies a animation for the actor
Parameters
| animLib | Animation library |
|---|---|
| animName | Animation name |
| animSpeed | Animation speed (default is 4.1) |
| loop | If the animation should loop |
| lockX | If the actor return to their old x-location (false = return to old, true = stay at new) |
| lockY | If the actor return to their old y-location (false = return to old, true = stay at new) |
| freeze | If the actor should be frozen while the animation is playing |
| time | How long the animation should play (0 = infinite) |
public abstract void clearAnimation ()
Clears all animations from the actor
public static abstract Actor get (int id)
Get a actor by it's id
Parameters
| id | Actor id |
|---|
Returns
- The found actor (null if not found)
public static abstract Collection<Actor> getActors ()
Get all actors available
Returns
- Collection of actors
public abstract float getAngle ()
Gets the facing angle of the actor
Returns
- The actor's facing angle
public abstract float getHealth ()
Get the current health of the actor
Returns
- The actor's health
public abstract int getId ()
Get the internal id of the actor
Returns
- The id
public abstract AngledLocation getLocation ()
Gets the location of the actor
Returns
- The actor's location
public abstract int getModel ()
Gets the model if the actor
Returns
- Modelid
public static abstract int getPoolSize ()
Gets the actor's pool size
Returns
- Actor's pool size
public abstract int getVirtualWorld ()
Gets the virtual world of the actor
Returns
- The actor's virtual world
public abstract boolean isActorStreamedIn (Player player)
Checks if the actor is streamed-in for a specific player
Parameters
| player | Player to check |
|---|
Returns
- If he's streamed-in for the player
public abstract boolean isInvulnerable ()
Gets the actor's invulnerable state
Returns
- The Actor's invulnerable state
public abstract void setAngle (float angle)
Sets the actor's facing angle
Parameters
| angle | Facing angle |
|---|
public abstract void setHealth (float health)
Sets the actor's health
Parameters
| health | Health |
|---|
public abstract void setInvulnerable (boolean invulnerable)
Sets the actor's invulnerable state
Parameters
| invulnerable | If he's invulnerable or not (true = yes, false = no) |
|---|
public abstract void setLocation (AngledLocation loc)
Sets the actor's location
Parameters
| loc | Location |
|---|
public abstract void setVirtualWorld (int world)
Sets the actor's virtual world
Parameters
| world | WorldID |
|---|