com.threerings.tudey.config
Class EffectSpriteConfig

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.tudey.config.EffectSpriteConfig

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Direct Known Subclasses:

EffectSpriteConfig.Animator, EffectSpriteConfig.Default

@EditorTypes(value={EffectSpriteConfig.Default.class,EffectSpriteConfig.Animator.class})
public abstract class EffectSpriteConfig
extends DeepObject
implements Exportable

The configuration of an effect sprite.

Nested Class Summary

static class	EffectSpriteConfig.Animator A sprite that plays an animation on another sprite.
static class	EffectSpriteConfig.Default The default sprite.

Field Summary

boolean	attachToTarget Whether or not to attach the transient to the target (if it has one).
int	floorMask Determines which floor categories the effect lies over.
ConfigReference<ModelConfig>	model The transient to fire off for the effect.

Constructor Summary

EffectSpriteConfig()

Method Summary

abstract EffectSprite.Implementation	createImplementation(TudeyContext ctx, Scope scope, Effect effect) Creates a sprite implementation for this configuration.
void	getPreloads(ConfigManager cfgmgr, PreloadableSet preloads) Adds the resources to preload for this sprite into the provided set.

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

floorMask

@Editable(editor="mask",
          mode="floor",
          hgroup="a")
public int floorMask

Determines which floor categories the effect lies over.

attachToTarget

@Editable(hgroup="a")
public boolean attachToTarget

Whether or not to attach the transient to the target (if it has one).

model

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

The transient to fire off for the effect.

Constructor Detail

EffectSpriteConfig

public EffectSpriteConfig()

Method Detail

getPreloads

public void getPreloads(ConfigManager cfgmgr,
                        PreloadableSet preloads)

Adds the resources to preload for this sprite into the provided set.

createImplementation

public abstract EffectSprite.Implementation createImplementation(TudeyContext ctx,
                                                                 Scope scope,
                                                                 Effect effect)

Creates a sprite implementation for this configuration.