Ribbon (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.pokemon.ribbon.Ribbon

```
public class Ribbon
extends java.lang.Object
```
This class represents a ribbon that has been given to a Pokemon. For a description of ribbons please see RibbonType This is only used to store data about the ribbon given to a Pokemon.

Since:

20/12/2022

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Ribbon.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`receivedDate`
`protected net.minecraft.util.text.ITextComponent`	`receiver`
`protected MutableRibbonData`	`ribbonData`
`protected java.lang.String`	`type`

Constructor Summary

Constructors
Constructor and Description
`Ribbon(java.lang.String type, long receivedDate, net.minecraft.util.text.ITextComponent receiver)`
`Ribbon(java.lang.String type, long receivedDate, net.minecraft.util.text.ITextComponent receiver, MutableRibbonData ribbonData)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Ribbon.Builder`	`builder()`
`static Ribbon.Builder`	`builder(Ribbon ribbon)`
`boolean`	`equals(java.lang.Object o)`
`static Ribbon`	`fromNbt(net.minecraft.nbt.CompoundNBT nbt)` Reads a ribbon from NBT
`long`	`getReceivedDate()` The date (in milliseconds) that the ribbon was given to the pokemon
`net.minecraft.util.text.ITextComponent`	`getReceiver()` The name of the owner of the Pokemon when it was given the ribbon
`MutableRibbonData`	`getRibbonData()` The mutable data for the ribbon.
`RegistryValue<RibbonType>`	`getType()` Returns the ribbon type for the given ribbon
`int`	`hashCode()`
`void`	`refreshData(PixelmonEntity entity)` Updates the mutable data that will be sent to the client This also marks the Pokemon's ribbon data as "dirty"
`net.minecraft.nbt.CompoundNBT`	`serialize()` Writes the Ribbon to an NBT compount

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

Field Detail

type
```
protected final java.lang.String type
```

receivedDate
```
protected final long receivedDate
```

receiver

protected final net.minecraft.util.text.ITextComponent receiver

ribbonData
```
protected MutableRibbonData ribbonData
```

Constructor Detail

Ribbon

public Ribbon(java.lang.String type,
              long receivedDate,
              net.minecraft.util.text.ITextComponent receiver)

Ribbon

public Ribbon(java.lang.String type,
              long receivedDate,
              net.minecraft.util.text.ITextComponent receiver,
              MutableRibbonData ribbonData)

Method Detail
- getType
```
public RegistryValue<RibbonType> getType()
```
  Returns the ribbon type for the given ribbon
  
  Returns:
  
  The ribbon type
- getReceivedDate
```
public long getReceivedDate()
```
  The date (in milliseconds) that the ribbon was given to the pokemon
  
  Returns:
  
  The date
- getReceiver
```
public net.minecraft.util.text.ITextComponent getReceiver()
```
  The name of the owner of the Pokemon when it was given the ribbon
  
  Returns:
  
  The owner
- getRibbonData
```
public MutableRibbonData getRibbonData()
```
  The mutable data for the ribbon. This is used by the client to know what to render
  
  Returns:
  
  The data for the client
- refreshData
```
public void refreshData(PixelmonEntity entity)
```
  Updates the mutable data that will be sent to the client This also marks the Pokemon's ribbon data as "dirty"
  
  Parameters:
  
  entity - The entity to update
- serialize
```
public net.minecraft.nbt.CompoundNBT serialize()
```
  Writes the Ribbon to an NBT compount
  
  Returns:
  
  The NBT version of the ribbon
- equals
```
public boolean equals(java.lang.Object o)
```
  Overrides:
  
  equals in class java.lang.Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- fromNbt
```
public static Ribbon fromNbt(net.minecraft.nbt.CompoundNBT nbt)
```
  Reads a ribbon from NBT
  
  Parameters:
  
  nbt - the nbt being read
  
  Returns:
  
  The ribbon
- builder
```
public static Ribbon.Builder builder()
```
- builder
```
public static Ribbon.Builder builder(Ribbon ribbon)
```

Class Ribbon

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

receivedDate

receiver

ribbonData

Constructor Detail

Ribbon

Ribbon

Method Detail

getType

getReceivedDate

getReceiver

getRibbonData

refreshData

serialize

equals

hashCode

fromNbt

builder

builder