SimpleRibbonType (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.pokemon.ribbon.type.impl.SimpleRibbonType

All Implemented Interfaces:

RibbonType, ITranslatable

Direct Known Subclasses:

DeveloperRibbonType
```
public class SimpleRibbonType
extends java.lang.Object
implements RibbonType
```
A very simple core implementation of a RibbonType that has all the attributes

Since:

20/12/2022

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SimpleRibbonType.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SimpleRibbonType.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected net.minecraft.util.text.ITextComponent`	`description`
`protected ResourceWithFallback`	`icon`
`protected java.lang.String`	`id`
`protected PaletteProperties`	`palette`
`protected net.minecraft.util.text.ITextComponent`	`prefix`
`protected net.minecraft.util.text.ITextComponent`	`suffix`
`protected java.lang.String`	`translationKey`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SimpleRibbonType(java.lang.String id, java.lang.String translationKey, ResourceWithFallback icon, net.minecraft.util.text.ITextComponent description, net.minecraft.util.text.ITextComponent prefix, net.minecraft.util.text.ITextComponent suffix, PaletteProperties palette)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SimpleRibbonType.Builder`	`builder()`
`net.minecraft.util.text.ITextComponent`	`getDescription()` Gets the description of the ribbon that will show up in the GUI when selected
`ResourceWithFallback`	`getIcon(Pokemon pokemon, Ribbon ribbon)` Gets the `ResourceLocation`, which should be a texture (.png), that will show up in the ribbons UI.
`net.minecraft.util.text.ITextComponent`	`getNamePrefix(PixelmonEntity pixelmon, Ribbon ribbon)` Gets the prefix that will be applied to the entity when they are in the world and this ribbon is applied.
`net.minecraft.util.text.ITextComponent`	`getNameSuffix(PixelmonEntity pixelmon, Ribbon ribbon)` Gets the suffix that will be applied to the entity when they are in the world and this ribbon is applied.
`PaletteProperties`	`getPaletteOverride(PixelmonEntity pixelmon, Ribbon ribbon)` Gets the override palette for the pixelmon entity when it is in the world.
`java.lang.String`	`getTranslationKey()`
`java.lang.String`	`id()` The unique identifier of the ribbon type

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

Methods inherited from interface com.pixelmonmod.pixelmon.api.pokemon.ribbon.type.RibbonType
onTick

Methods inherited from interface com.pixelmonmod.pixelmon.api.util.ITranslatable
getLocalizedName, getTranslatedName

- Field Detail
  - id
```
protected final java.lang.String id
```
  - translationKey
```
protected final java.lang.String translationKey
```
  - icon
```
protected final ResourceWithFallback icon
```
  - description
```
protected final net.minecraft.util.text.ITextComponent description
```
  - prefix
```
protected final net.minecraft.util.text.ITextComponent prefix
```
  - suffix
```
protected final net.minecraft.util.text.ITextComponent suffix
```
  - palette
```
protected final PaletteProperties palette
```
- Constructor Detail
  - SimpleRibbonType
```
protected SimpleRibbonType(java.lang.String id,
                           java.lang.String translationKey,
                           ResourceWithFallback icon,
                           net.minecraft.util.text.ITextComponent description,
                           net.minecraft.util.text.ITextComponent prefix,
                           net.minecraft.util.text.ITextComponent suffix,
                           PaletteProperties palette)
```
- Method Detail
  - id
```
public java.lang.String id()
```
    Description copied from interface: RibbonType
    
    The unique identifier of the ribbon type
    
    Specified by:
    
    id in interface RibbonType
    
    Returns:
    
    The identifier
  - getIcon
```
@Nonnull
public ResourceWithFallback getIcon(Pokemon pokemon,
                                             Ribbon ribbon)
```
    Description copied from interface: RibbonType
    
    Gets the ResourceLocation, which should be a texture (.png), that will show up in the ribbons UI.
    
    Specified by:
    
    getIcon in interface RibbonType
    
    Parameters:
    
    pokemon - The pokemon being viewed
    
    ribbon - The ribbon getting the icon for
    
    Returns:
    
    The texture of the icon
  - getNamePrefix
```
@Nullable
public net.minecraft.util.text.ITextComponent getNamePrefix(PixelmonEntity pixelmon,
                                                                      Ribbon ribbon)
```
    Description copied from interface: RibbonType
    
    Gets the prefix that will be applied to the entity when they are in the world and this ribbon is applied. This can return null, and when it returns null no such prefix will be applied.
    
    Specified by:
    
    getNamePrefix in interface RibbonType
    
    Parameters:
    
    pixelmon - The pixelmon entity being given a prefix in the world
    
    ribbon - The ribbon applicable
    
    Returns:
    
    The prefix to be applied (default is null)
  - getNameSuffix
```
@Nullable
public net.minecraft.util.text.ITextComponent getNameSuffix(PixelmonEntity pixelmon,
                                                                      Ribbon ribbon)
```
    Description copied from interface: RibbonType
    
    Gets the suffix that will be applied to the entity when they are in the world and this ribbon is applied. This can return null, and when it returns null no such suffix will be applied.
    
    Specified by:
    
    getNameSuffix in interface RibbonType
    
    Parameters:
    
    pixelmon - The pixelmon entity being given a suffix in the world
    
    ribbon - The ribbon applicable
    
    Returns:
    
    The suffix to be applied (default is null)
  - getDescription
```
public net.minecraft.util.text.ITextComponent getDescription()
```
    Description copied from interface: RibbonType
    
    Gets the description of the ribbon that will show up in the GUI when selected
    
    Specified by:
    
    getDescription in interface RibbonType
    
    Returns:
    
    The description
  - getPaletteOverride
```
@Nullable
public PaletteProperties getPaletteOverride(PixelmonEntity pixelmon,
                                                      Ribbon ribbon)
```
    Description copied from interface: RibbonType
    
    Gets the override palette for the pixelmon entity when it is in the world. This means that when the Pokemon has the ribbon equippied it will look (or sound) different from it's normal form or palette. The only default implementation/usage of this will be creator forms/palettes This can return null, and when it returns null there will be no palette override applied.
    
    Specified by:
    
    getPaletteOverride in interface RibbonType
    
    Parameters:
    
    pixelmon - The pixelmon entity being checked against
    
    ribbon - The ribbon applicable
    
    Returns:
    
    The override palette
  - getTranslationKey
```
public java.lang.String getTranslationKey()
```
    Specified by:
    
    getTranslationKey in interface ITranslatable
  - builder
```
public static SimpleRibbonType.Builder builder()
```

Class SimpleRibbonType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.pixelmonmod.pixelmon.api.pokemon.ribbon.type.RibbonType

Methods inherited from interface com.pixelmonmod.pixelmon.api.util.ITranslatable

Field Detail

id

translationKey

icon

description

prefix

suffix

palette

Constructor Detail

SimpleRibbonType

Method Detail

id

getIcon

getNamePrefix

getNameSuffix

getDescription

getPaletteOverride

getTranslationKey

builder