com.threerings.tudey.config
Class ActorSpriteConfig

java.lang.Object
  extended by com.threerings.util.DeepObject
      extended by com.threerings.tudey.config.ActorSpriteConfig
All Implemented Interfaces:
Exportable, Copyable, Cloneable
Direct Known Subclasses:
ActorSpriteConfig.Default

@EditorTypes(value={ActorSpriteConfig.Default.class,ActorSpriteConfig.Moving.class,ActorSpriteConfig.StatefulEntry.class})
public abstract class ActorSpriteConfig
extends DeepObject
implements Exportable

The configuration of an actor sprite.


Nested Class Summary
static class ActorSpriteConfig.Default
          The default sprite.
static class ActorSpriteConfig.MovementSet
          Represents a set of movement animations.
static class ActorSpriteConfig.Moving
          A sprite with idle and movement animations.
static class ActorSpriteConfig.QuadMovement
          A movement set with separate animations for the four directions.
static class ActorSpriteConfig.RotationSet
          Represents a set of rotation animations.
static class ActorSpriteConfig.SingleMovement
          A movement set with a single animation.
static class ActorSpriteConfig.State
          Represents a single animated state.
static class ActorSpriteConfig.StatefulEntry
          Manipulates an entry sprite to reflect the state of the entry's corresponding actor.
static class ActorSpriteConfig.WeightedAnimation
          Contains an animation reference and an associated weight.
 
Field Summary
 ConfigReference<ModelConfig> creationTransient
          A transient to spawn when the actor is created.
 ConfigReference<ModelConfig> destructionTransient
          A transient to spawn when the actor is destroyed.
 int floorFlags
          Determines which floor categories the sprite belongs to.
 int floorMask
          Determines which floor categories the actor walks over.
 ConfigReference<ModelConfig> model
          The actor model.
 
Constructor Summary
ActorSpriteConfig()
           
 
Method Summary
abstract  ActorSprite.Implementation getImplementation(TudeyContext ctx, Scope scope, ActorSprite.Implementation impl)
          Creates or updates a sprite implementation for this configuration.
 void getPreloads(ConfigManager cfgmgr, PreloadableSet preloads)
          Adds the resources to preload for this sprite into the provided set.
 void invalidate()
          Invalidates any cached data.
 
Methods inherited from class com.threerings.util.DeepObject
clone, copy, copy, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

floorFlags

@Editable(editor="mask",
          mode="floor",
          hgroup="f")
public int floorFlags
Determines which floor categories the sprite belongs to.


floorMask

@Editable(editor="mask",
          mode="floor",
          hgroup="f")
public int floorMask
Determines which floor categories the actor walks over.


model

@Editable(nullable=true)
public ConfigReference<ModelConfig> model
The actor model.


creationTransient

@Editable(nullable=true)
public ConfigReference<ModelConfig> creationTransient
A transient to spawn when the actor is created.


destructionTransient

@Editable(nullable=true)
public ConfigReference<ModelConfig> destructionTransient
A transient to spawn when the actor is destroyed.

Constructor Detail

ActorSpriteConfig

public ActorSpriteConfig()
Method Detail

getPreloads

public void getPreloads(ConfigManager cfgmgr,
                        PreloadableSet preloads)
Adds the resources to preload for this sprite into the provided set.


getImplementation

public abstract ActorSprite.Implementation getImplementation(TudeyContext ctx,
                                                             Scope scope,
                                                             ActorSprite.Implementation impl)
Creates or updates a sprite implementation for this configuration.


invalidate

public void invalidate()
Invalidates any cached data.



Copyright © 2011. All Rights Reserved.