Polymer

https://polymer.pb4.eu/latest/
Admin
Polymer is a set of Minecraft libraries for creating server-side content including blocks, items,...
Tokens:7,743
Snippets:48
Trust Score:6.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### Override onPolymerBlockSend to send additional data

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Override onPolymerBlockSend to send additional data for signs, heads, or custom client-side customization. This example sends the packet required to render a player head with a skin. Ideally, only send packets here.

```java
@Override
public void onPolymerBlockSend(BlockState blockState, BlockPos.Mutable pos, PacketContext.NotNullWithPlayer context) { 
    player.networkHandler.sendPacket(this.getPolymerHeadPacket(blockState, pos.toImmutable()));
}

```

--------------------------------

### Override getPolymerVisibleEquipment to replace helmet

Source: https://polymer.pb4.eu/latest/polymer-core/entities

Override this method to modify the equipment shown to clients. The example removes the original head item and replaces it with a wither skeleton skull.

```java
@Override
public List<Pair<EquipmentSlot, ItemStack>> getPolymerVisibleEquipment(List<Pair<EquipmentSlot, ItemStack>> items, ServerPlayerEntities player) {
    var list = new ArrayList<Pair<EquipmentSlot, ItemStack>>(map.size());
    for (var entry : items) {
        if (entry.getKey() == EquipmentSlot.HEAD) {
            continue;
        } else {
            list.add(Pair.of(entry.getKey(), entry.getValue()));
        }
    }
    list.add(new Pair<>(EquipmentSlot.HEAD, new ItemStack(Items.WITHER_SKELETON_SKULL)));

    return list;
}

```

--------------------------------

### Override getPolymerBlockState to change client-side and collision blockstates

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Override getPolymerBlockState to change the client-side blockstate and the blockstate used for server-side collisions. This example changes the block to a furnace with the same facing but inverted 'lit' property. You can return other PolymerBlock states, but nesting is limited to 32.

```java
@Override
public BlockState getPolymerBlockState(BlockState state, PacketContext context) {
    return Blocks.FURNACE.getDefaultState()
            .with(AbstractFurnaceBlock.FACING, state.get(AbstractFurnaceBlock.FACING))
            .with(AbstractFurnaceBlock.LIT, !state.get(AbstractFurnaceBlock.LIT));
}

```

--------------------------------

### PolymerBlock Interface Methods

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Methods from the PolymerBlock interface and PolymerHeadBlock interface that can be overridden to customize block behavior.

```APIDOC
## [METHOD] getPolymerBlock

### Description
Overrides the base block type used for the client-side representation of this block. This method is part of the PolymerBlock interface and must not return null.

### Method
Override method

### Endpoint
Block.getPolymerBlock(BlockState state, PacketContext context)

### Parameters
#### Method Parameters
- **state** (BlockState) - Required - The current block state.
- **context** (PacketContext) - Required - The packet context.

### Request Example
```java
@Override
public Block getPolymerBlock(BlockState state, PacketContext context) {
    return Blocks.BARRIER;
}
```

### Response
#### Success Response
- **Block** - The base block to use for client-side representation.

#### Response Example
```java
Blocks.BARRIER
```
```

```APIDOC
## [METHOD] getPolymerBlock (overload)

### Description
Overrides the base block type based on the player. This method is part of the PolymerBlock interface and must not return null.

### Method
Override method

### Endpoint
Block.getPolymerBlock(ServerPlayerEntity player, BlockState state)

### Parameters
#### Method Parameters
- **player** (ServerPlayerEntity) - Required - The player to determine the block for.
- **state** (BlockState) - Required - The current block state.

### Request Example
```java
@Override
public Block getPolymerBlock(ServerPlayerEntity player, BlockState state) {
    return Something.isRedTeam(player) ? Blocks.RED_WOOL : Blocks.BLUE_WOOL;
}
```

### Response
#### Success Response
- **Block** - The base block to use for client-side representation.

#### Response Example
```java
Blocks.RED_WOOL
```
```

```APIDOC
## [METHOD] getPolymerBlockState

### Description
Overrides the block state visible on the client and used for server-side collisions. Can return other BlockState of PolymerBlock, but nesting is limited to 32.

### Method
Override method

### Endpoint
Block.getPolymerBlockState(BlockState state, PacketContext context)

### Parameters
#### Method Parameters
- **state** (BlockState) - Required - The current block state.
- **context** (PacketContext) - Required - The packet context.

### Request Example
```java
@Override
public BlockState getPolymerBlockState(BlockState state, PacketContext context) {
    return Blocks.FURNACE.getDefaultState()
            .with(AbstractFurnaceBlock.FACING, state.get(AbstractFurnaceBlock.FACING))
            .with(AbstractFurnaceBlock.LIT, !state.get(AbstractFurnaceBlock.LIT));
}
```

### Response
#### Success Response
- **BlockState** - The block state to use for client-side and collision.

#### Response Example
```java
Blocks.FURNACE.getDefaultState()
```
```

```APIDOC
## [METHOD] onPolymerBlockSend

### Description
Called when the block is sent to the client, allowing additional data to be sent (e.g., for signs, heads, or companion mods). Ideally used only for sending packets.

### Method
Override method

### Endpoint
Block.onPolymerBlockSend(BlockState blockState, BlockPos.Mutable pos, PacketContext.NotNullWithPlayer context)

### Parameters
#### Method Parameters
- **blockState** (BlockState) - Required - The block state being sent.
- **pos** (BlockPos.Mutable) - Required - The mutable position of the block.
- **context** (PacketContext.NotNullWithPlayer) - Required - The packet context with a non-null player.

### Request Example
```java
@Override
public void onPolymerBlockSend(BlockState blockState, BlockPos.Mutable pos, PacketContext.NotNullWithPlayer context) { 
    player.networkHandler.sendPacket(this.getPolymerHeadPacket(blockState, pos.toImmutable()));
}
```

### Response
#### Success Response
- **void** - No return value.
```

```APIDOC
## [METHOD] getPolymerSkinValue

### Description
Returns the texture value for a player head block. This method is part of the PolymerHeadBlock interface.

### Method
Override method

### Endpoint
PolymerHeadBlock.getPolymerSkinValue(BlockState state, BlockPos pos, PacketContext.NotNullWithPlayer context)

### Parameters
#### Method Parameters
- **state** (BlockState) - Required - The current block state.
- **pos** (BlockPos) - Required - The position of the block.
- **context** (PacketContext.NotNullWithPlayer) - Required - The packet context with a non-null player.

### Request Example
```java
@Override
public String getPolymerSkinValue(BlockState state, BlockPos pos, PacketContext.NotNullWithPlayer context) {
    return "ewogICJ0aW1lc3RhbXAiIDogMTYxNzk3NjcxOTAzNSwKICAicHJvZmlsZUlkIiA6ICJlZDUzZGQ4MTRmOWQ0YTNjYjRlYjY1MWRjYmE3N2U2NiIsCiAgInByb2ZpbGVOYW1lIiA6ICI0MTQxNDE0MWgiLAogICJzaWduYXR1cmVSZXF1aXJlZCIgOiB0cnVlLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNTczNTE0YTIzMjQ1ZjE1ZGJhZDVmYjRlNjIyMTYzMDIwODY0Y2NlNGMxNWQ1NmRlM2FkYjkwZmE1YTcxMzdmZCIKICAgIH0KICB9Cn0";
}
```

### Response
#### Success Response
- **String** - The texture value for the player head skin.

#### Response Example
```java
"ewogICJ0aW1lc3RhbXAiIDogMTYxNzk3NjcxOTAzNSwKICAicHJvZmlsZUlkIiA6ICJlZDUzZGQ4MTRmOWQ0YTNjYjRlYjY1MWRjYmE3N2U2NiIsCiAgInByb2ZpbGVOYW1lIiA6ICI0MTQxNDE0MWgiLAogICJzaWduYXR1cmVSZXF1aXJlZCIgOiB0cnVlLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNTczNTE0YTIzMjQ1ZjE1ZGJhZDVmYjRlNjIyMTYzMDIwODY0Y2NlNGMxNWQ1NmRlM2FkYjkwZmE1YTcxMzdmZCIKICAgIH0KICB9Cn0"
```
```

--------------------------------

### PolymerBlockUtils.getBlockStateSafely

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Retrieves a client-friendly representation of a block state, returning air if the conversion fails.

```APIDOC
## getBlockStateSafely

### Description
Returns a client-friendly representation of a block, or air in case of failure.

### Method
getBlockStateSafely

### Parameters
- `block` (PolymerBlock) - Required - The PolymerBlock instance.
- `blockState` (BlockState) - Required - The original BlockState.
- `context` (PacketContext) - Required - The packet context.

### Returns
- `BlockState` - A block state safe to use on the client, or air on failure.

### Example
```java
BlockState safeState = PolymerBlockUtils.getBlockStateSafely(block, blockState, context);
```
```

--------------------------------

### Add Polymer Blocks dependencies to build.gradle

Source: https://polymer.pb4.eu/latest/polymer-blocks/getting-started

Adds the required Polymer modules to a Gradle project. The maven repository is required for resolving the dependencies. Replace [TAG] with the desired version, checking the provided maven for the latest polymer-blocks version.

```groovy
repositories {
    maven { url 'https://maven.nucleoid.xyz' } // You should have it
}

dependencies {
    modImplementation include("eu.pb4:polymer-core:[TAG]")
    modImplementation include("eu.pb4:polymer-blocks:[TAG]")
    modImplementation include("eu.pb4:polymer-resource-pack:[TAG]")
}

```

--------------------------------

### Add polymer-virtual-entity dependency

Source: https://polymer.pb4.eu/latest/polymer-virtual-entity/getting-started

Add the Nucleoid maven repository and include the polymer-virtual-entity dependency in your Gradle build. Replace [TAG] with the version from the maven.

```groovy
repositories {
    maven { url 'https://maven.nucleoid.xyz' } // You should have it
}

dependencies {
    modImplementation include("eu.pb4:polymer-virtual-entity:[TAG]")
}

```

--------------------------------

### Override getPolymerBlock to change base block

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Override getPolymerBlock to change the base block sent to the client. The first method returns a fixed block (BARRIER); the second returns a block based on a condition (team color). Both methods must not return null and can point to other PolymerBlock instances, but validate if configurable by the user.

```java
@Override
public Block getPolymerBlock(BlockState state, PacketContext context) {
    return Blocks.BARRIER;
}

public Block getPolymerBlock(ServerPlayerEntity player, BlockState state) {
    return Something.isRedTeam(player) ? Blocks.RED_WOOL : Blocks.BLUE_WOOL;
}

```

--------------------------------

### Override getPolymerSkinValue to set skin texture

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Override getPolymerSkinValue to set the skin texture for a PolymerHeadBlock. The return value is a texture value string, which can be generated with websites like https://mineskin.org/. You can also override getPolymerBlockState to change the rotation of the player head block.

```java
@Override
public String getPolymerSkinValue(BlockState state, BlockPos pos, PacketContext.NotNullWithPlayer context) {
    return "ewogICJ0aW1lc3RhbXAiIDogMTYxNzk3NjcxOTAzNSwKICAicHJvZmlsZUlkIiA6ICJlZDUzZGQ4MTRmOWQ0YTNjYjRlYjY1MWRjYmE3N2U2NiIsCiAgInByb2ZpbGVOYW1lIiA6ICI0MTQxNDE0MWgiLAogICJzaWduYXR1cmVSZXF1aXJlZCIgOiB0cnVlLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNTczNTE0YTIzMjQ1ZjE1ZGJhZDVmYjRlNjIyMTYzMDIwODY0Y2NlNGMxNWQ1NmRlM2FkYjkwZmE1YTcxMzdmZCIKICAgIH0KICB9Cn0";
}

```

--------------------------------

### Override getPolymerEntityType to display as zombie

Source: https://polymer.pb4.eu/latest/polymer-core/entities

Override this method to select the visual entity type sent to the client. Returning null or another virtual entity type will not work.

```java
@Override
public EntityType<?> getPolymerEntityType(PacketContext context) {
    return EntityType.ZOMBIE;
}

```

--------------------------------

### PolymerBlockUtils.registerBlockEntity

Source: https://polymer.pb4.eu/latest/polymer-core/blocks

Registers a BlockEntityType to prevent its BlockEntities from being sent to the client.

```APIDOC
## registerBlockEntity

### Description
Registers a BlockEntityType so that its BlockEntities are not sent to the client.

### Method
registerBlockEntity

### Parameters
- `types` (BlockEntityType) - Required - The BlockEntityType to register.

### Example
```java
PolymerBlockUtils.registerBlockEntity(BlockEntityType type);
```
```

--------------------------------

### Override modifyRawTrackedData to add villager data

Source: https://polymer.pb4.eu/latest/polymer-core/entities

Override this method to directly modify DataTracker values sent to the client. Sending entries that do not exist on the client-side entity representation will cause errors.

```java
@Override
public void modifyRawTrackedData(List<DataTracker.SerializedEntry<?>> data, ServerPlayerEntity player, boolean initial) {
    data.add(DataTracker.SerializedEntry.of(VillagerEntityAccessor.getVillagerData(), new VillagerData(VillagerType.JUNGLE, VillagerProfession.FARMER, 3);));
}

```
Tokens:
Raw