Artifact Buff - Code References

The Artifact Buff is a base class for all buffs that are applied by artifacts (rings, artifacts, and similar equipment). It extends the standard Buff system and provides special handling for artifact-sourced buffs.

Base Implementation:

• `com/watabou/pixeldungeon/items/rings/ArtifactBuff.java` - Base class for all artifact buffs
• Extends: `com/watabou/pixeldungeon/actors/buffs/Buff`
• Package: `com.watabou.pixeldungeon.items.rings`

Key Characteristics:

• Artifact buffs are tied to their source artifact through the source ID system
• They automatically detach when the source artifact is removed
• They use the `EntityIdSource` system to track their origin

Key Methods:

// In ArtifactBuff.java
public class ArtifactBuff extends Buff {
    @Override
    public boolean act() {
        if(getSourceId()==EntityIdSource.INVALID_ID) { // non-artifact source
            detach();
        }
        return super.act();
    }
 
    public String getEntityKind() {
        return "artifactBuff" + super.getEntityKind();
    }
 
    @Override
    public boolean dontPack() {
        return getSourceId()!= EntityIdSource.INVALID_ID;
    }
}

Source Tracking:

• Artifact buffs maintain a reference to their source artifact via `getSourceId()`
• If the source becomes invalid (`EntityIdSource.INVALID_ID`), the buff automatically detaches
• This ensures buffs don't persist after their source artifact is removed

Serialization:

• The `dontPack()` method returns `true` for artifact buffs with valid sources
• This prevents unnecessary serialization of temporary buff state

Entity Kind:

• Artifact buffs prepend “artifactBuff” to their entity kind
• This allows for easy identification and filtering of artifact-sourced buffs

Artifact buffs do not have separate JSON configuration files. They are:

• Defined entirely in Java code
• Registered through the buff factory system
• Associated with their parent artifacts

Artifact buffs inherit their display names and descriptions from their parent artifacts. Individual buff implementations may override these in string resource files.

Artifact buffs are implemented entirely in Java. No Lua scripts are used for the base ArtifactBuff class.

Base Classes:

• Buff - Base buff system
• Buff.java - Full Buff implementation

Related Interfaces:

• NamedEntityKind - Entity identification interface
• EntityIdSource.java - Source ID management

Example Artifact Buffs:

• Stone Walking Buff - Doom-type artifact buff from Ring of Stone Blood
• Ring of Accuracy - Accuracy-boosting artifact buff
• Ring of Haste - Speed-boosting artifact buff

• Java: ArtifactBuff.java
• Java: Buff.java
• Java: EntityIdSource.java