java.lang.Object
- net.runelite.api.RuneLiteObjectController
- - net.runelite.api.RuneLiteObject

public class RuneLiteObject
extends RuneLiteObjectController

Constructor Summary

Constructors
Constructor Description

RuneLiteObject(Client client)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`finished()`	Deprecated. Use a custom `AnimationController` instead.
`Animation`	`getAnimation()`	Deprecated. Use `getAnimationController()` or `getPoseAnimationController()` followed by `AnimationController.getFrame()`.
`AnimationController`	`getAnimationController()`	The animation of the RuneLiteObject.
`int`	`getAnimationFrame()`	Deprecated. Use `getAnimationController()` or `getPoseAnimationController()` followed by `AnimationController.getFrame()`.
`Model`	`getBaseModel()`
`Model`	`getModel()`	Called every frame to get a model to render.
`AnimationController`	`getPoseAnimationController()`	The optional pose animation of the RuneLiteObject.
`int`	`getStartCycle()`
`boolean`	`isActive()`	Gets the state of the RuneLiteObject
`void`	`setActive(boolean active)`	Sets the state of the RuneLiteObject.
`void`	`setAnimation(Animation animation)`	Sets the animation of the RuneLiteObject.
`void`	`setAnimationController(AnimationController animationController)`	Sets the animation controller of the RuneLiteObject.
`void`	`setFinished(boolean finished)`	Deprecated. Use a custom `AnimationController` instead to despawn the object when it completes its animation.
`void`	`setLocation(LocalPoint point, int level)`	Sets the location in the scene for the RuneLiteObject
`void`	`setModel(Model baseModel)`	Sets the model to be rendered.
`void`	`setPoseAnimationController(AnimationController poseAnimationController)`	The optional pose animation of the RuneLiteObject.
`void`	`setShouldLoop(boolean shouldLoop)`	Deprecated. Use `AnimationController.setOnFinished(Consumer)` with `AnimationController.loop()` instead.
`void`	`setStartCycle(int startCycle)`
`void`	`tick(int ticksSinceLastFrame)`	Called every frame the RuneLiteObject is registered and in the scene

Methods inherited from class net.runelite.api.RuneLiteObjectController
getLevel, getLocation, getOrientation, getRadius, getWorldView, getX, getY, getZ, isDrawFrontTilesFirst, setDrawFrontTilesFirst, setLevel, setOrientation, setRadius, setWorldView, setX, setY, setZ

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RuneLiteObject
```
public RuneLiteObject(Client client)
```
- Method Detail
  - setShouldLoop
```
@Deprecated
public void setShouldLoop(boolean shouldLoop)
```
    Deprecated.
    Use AnimationController.setOnFinished(Consumer) with AnimationController.loop() instead.
    
    Sets whether the animation of the RuneLiteObject should loop when the animation ends. If this is false the object will despawn when the animation ends. Does nothing if the animation is null.
  - setModel
```
public void setModel(Model baseModel)
```
    Sets the model to be rendered. If animationController is not null, this model will be passed to AnimationController.animate(Model).
  - setLocation
```
public void setLocation(LocalPoint point,
                        int level)
```
    Sets the location in the scene for the RuneLiteObject
    
    Overrides:
    
    setLocation in class RuneLiteObjectController
  - setAnimation
```
public void setAnimation(Animation animation)
```
    Sets the animation of the RuneLiteObject. If animation is null, the model will be static.
  - setAnimationController
```
public void setAnimationController(@Nullable
                                   AnimationController animationController)
```
    Sets the animation controller of the RuneLiteObject. If animationController is null, the model will be static.
  - setActive
```
public void setActive(boolean active)
```
    Sets the state of the RuneLiteObject. Set to true to spawn the object. Set to false to despawn the object.
  - isActive
```
public boolean isActive()
```
    Gets the state of the RuneLiteObject
    
    Returns:
    
    true if the RuneLiteObject is added to the scene
  - tick
```
public void tick(int ticksSinceLastFrame)
```
    Called every frame the RuneLiteObject is registered and in the scene
    
    Overrides:
    
    tick in class RuneLiteObjectController
    
    Parameters:
    
    ticksSinceLastFrame - The number of client ticks since the last frame
  - getModel
```
public Model getModel()
```
    Called every frame to get a model to render. The returned model is not modified and can be a shared model.
    
    Specified by:
    
    getModel in class RuneLiteObjectController
  - finished
```
@Deprecated
public boolean finished()
```
    Deprecated.
    Use a custom AnimationController instead.
  - setFinished
```
@Deprecated
public void setFinished(boolean finished)
```
    Deprecated.
    Use a custom AnimationController instead to despawn the object when it completes its animation.
  - getAnimation
```
public Animation getAnimation()
```
    Deprecated.
    Use getAnimationController() or getPoseAnimationController() followed by AnimationController.getFrame().
  - getAnimationFrame
```
@Deprecated
public int getAnimationFrame()
```
    Deprecated.
    Use getAnimationController() or getPoseAnimationController() followed by AnimationController.getFrame().
  - getBaseModel
```
public Model getBaseModel()
```
  - getAnimationController
```
@Nullable
public AnimationController getAnimationController()
```
    The animation of the RuneLiteObject. If animation is null then the model will be static.
  - setPoseAnimationController
```
public void setPoseAnimationController(@Nullable
                                       AnimationController poseAnimationController)
```
    The optional pose animation of the RuneLiteObject. If animation is null then the model from animationController will be used.
  - getPoseAnimationController
```
@Nullable
public AnimationController getPoseAnimationController()
```
    The optional pose animation of the RuneLiteObject. If animation is null then the model from animationController will be used.
  - getStartCycle
```
public int getStartCycle()
```
  - setStartCycle
```
public void setStartCycle(int startCycle)
```

Class RuneLiteObject

Constructor Summary

Method Summary

Methods inherited from class net.runelite.api.RuneLiteObjectController

Methods inherited from class java.lang.Object

Constructor Detail

RuneLiteObject

Method Detail

setShouldLoop

setModel

setLocation

setAnimation

setAnimationController

setActive

isActive

tick

getModel

finished

setFinished

getAnimation

getAnimationFrame

getBaseModel

getAnimationController

setPoseAnimationController

getPoseAnimationController

getStartCycle

setStartCycle