Package net.citizensnpcs.trait

Class SkinTrait

java.lang.Object

net.citizensnpcs.api.trait.Trait

net.citizensnpcs.trait.SkinTrait

All Implemented Interfaces:

Runnable, Listener

public class SkinTrait
extends Trait

Field Summary

Fields inherited from class net.citizensnpcs.api.trait.Trait

npc

Constructor Summary

Constructors

Constructor	Description
SkinTrait()

Method Summary

Modifier and Type	Method	Description
void	applyTextureInternal(String signature, String value)
void	clearTexture()	Clears skin texture and name.
boolean	fetchDefaultSkin()	Whether to fetch the Mojang skin using the NPC's name on spawn.
String	getSignature()
String	getSkinName()
String	getTexture()
void	onSpawn()	Called when an NPC is spawned.
void	run()	Called every tick if overridden.
void	setFetchDefaultSkin(boolean fetch)
void	setShouldUpdateSkins(boolean update)
void	setSkinName(String name)	Sets the skin name - will respawn NPC if spawned.
void	setSkinName(String name, boolean forceUpdate)	Sets the skin name - will respawn NPC if spawned.
void	setSkinPatch(SkinnableEntity.PlayerSkinModelType modelType, NamespacedKey body, NamespacedKey cape, NamespacedKey elytra)	Sets the skin texture patch.
void	setSkinPersistent(String skinName, String signature, String data)	Sets the skin data directly, respawning the NPC if spawned.
void	setSkinPersistent(Player player)	Set skin data copying from a Player.
boolean	shouldUpdateSkins()

Methods inherited from class net.citizensnpcs.api.trait.Trait

getName, getNPC, isRunImplemented, linkToNPC, load, onAttach, onCopy, onDespawn, onDespawn, onPreSpawn, onRemove, onRemove, save

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SkinTrait

public SkinTrait()

Method Details

applyTextureInternal

public void applyTextureInternal(String signature,
 String value)

clearTexture

public void clearTexture()

Clears skin texture and name.

fetchDefaultSkin

public boolean fetchDefaultSkin()

Whether to fetch the Mojang skin using the NPC's name on spawn.

getSignature

public String getSignature()

Returns:

The texture signature, or null

getSkinName

public String getSkinName()

Returns:

The skin name if set, or null (i.e. using the NPC's name)

getTexture

public String getTexture()

Returns:

The encoded texture data, or null

onSpawn

public void onSpawn()

Description copied from class: Trait

Called when an NPC is spawned. NPC.getEntity() will return null until this is called. This is also called onAttach when the NPC is already spawned.

Overrides:

onSpawn in class Trait

run

public void run()

Description copied from class: Trait

Called every tick if overridden.

Specified by:

run in interface Runnable

Overrides:

run in class Trait

setFetchDefaultSkin

public void setFetchDefaultSkin(boolean fetch)

See Also:

• fetchDefaultSkin

setShouldUpdateSkins

public void setShouldUpdateSkins(boolean update)

See Also:

• shouldUpdateSkins()

setSkinName

public void setSkinName(String name)

Sets the skin name - will respawn NPC if spawned.

Parameters:

name - The skin name

setSkinName

public void setSkinName(String name,
 boolean forceUpdate)

Sets the skin name - will respawn NPC if spawned.

Parameters:

name - The skin name

forceUpdate - Whether to force update if no data has been fetched yet

See Also:

• Skin.get(SkinnableEntity, boolean)

setSkinPatch

public void setSkinPatch(SkinnableEntity.PlayerSkinModelType modelType,
 NamespacedKey body,
 NamespacedKey cape,
 NamespacedKey elytra)

Sets the skin texture patch. Only guaranteed to work on Mannequin NPCs.

Parameters:

patch -

setSkinPersistent

public void setSkinPersistent(Player player)

Set skin data copying from a Player. Not subject to rate limiting from Mojang.

Parameters:

player - The player to copy

setSkinPersistent

public void setSkinPersistent(String skinName,
 String signature,
 String data)

Sets the skin data directly, respawning the NPC if spawned.

Parameters:

skinName - Skin name or cache key

signature - getSignature()

data - getTexture()

shouldUpdateSkins

public boolean shouldUpdateSkins()

Returns:

Whether the skin should be updated from Mojang periodically