Skip to main content

Mythicmob NPC Definition

A MythicMob that can be used as an NPC

Fields

FieldTypeDefaultDescription
soundVar<Sound>EMPTY—
mobTypeVar<String>—The MythicMob type to spawn.
showDisplayNameBooleantrueWhether to show the display name above the mob.
showDisplayNameInCinematicBooleantrueWhether to show the display name during cinematics.
showDisplayNameInNavigationBooleantrueWhether to show the display name during navigation.
nameOffsetDouble2.3Y offset for the name display above the mob.
dataList<Ref<EntityData<*>>>empty—
tickingBooleanfalseWhether to tick the NPC for movement and updates. Off (the supported setting): a model carrier without AI, driven by Typewriter. On: a living mob with AI. Keep it off when another extension's instance, such as a dungeon NPC instance, displays this NPC: each viewer then gets a mob of their own, visible to them alone, that no instance manages. Either way a server mob exists; it is only hidden from the other players.
clientSideRadiusDouble0.0Radius in which the mob can move (requires ticking=true). If 0, movement is disabled.
cancelInteractAnimationBooleanfalseWhether to cancel the interact animation when a player interacts with the NPC.
Common TypeWriter fields (displayName)
FieldTypeDefaultDescription
displayNameVar<String>——

How to use it​

The definition says what the NPC is. It does not place anything in the world: link it from a MythicMob NPC Instance.

  • mobType is the MythicMobs internal name of the mob. It accepts variables and PlaceholderAPI placeholders.
  • displayName is the text shown above the head when showDisplayName is on. nameOffset raises or lowers it, and showDisplayNameInCinematic and showDisplayNameInNavigation hide it while a cinematic plays or while the mob is walking.
  • ticking off (default) gives each player their own copy of the mob, a model carrier without AI driven by Typewriter and visible to that player alone: it cannot move on its own and cannot cast skills from TypeWriter. ticking on spawns a real server-side mob.
  • clientSideRadius only applies with ticking on. At 0 the AI and gravity of the mob are switched off so it stays exactly where it is placed. Above 0 the mob can move, and it is despawned and respawned at its spawn point when it leaves that radius.
  • cancelInteractAnimation stops the model's interact animation from playing on right-click.
  • data takes entity data entries. The lines of a Lines data (extra text in the name tag), a custom name, Speed Data and ModelEngine Stance Data (both with ticking on only), Bone Visibility Data and Attachment Data are read. See the notes of each data entry.