MythicMob (MythicMobs 4.11.0-SNAPSHOT API)

java.lang.Object
- io.lumine.xikage.mythicmobs.mobs.MythicMob

All Implemented Interfaces:

Comparable<MythicMob>
```
public class MythicMob
extends Object
implements Comparable<MythicMob>
```
Represents a custom mob type

Author:

Ashijin

Field Summary

Fields
Modifier and Type	Field and Description
`protected PlaceholderDouble`	`attrArmor`
`protected double`	`attrAttackSpeed`
`protected PlaceholderDouble`	`attrDamage`
`protected double`	`attrFollowRange`
`protected PlaceholderDouble`	`attrHealth`
`protected double`	`attrKnockbackResist`
`protected PlaceholderDouble`	`attrMovementSpeed`
`protected AbstractBossBar.BarColor`	`bossBarColor`
`protected boolean`	`bossBarCreateFog`
`protected boolean`	`bossBarDarkenSky`
`protected boolean`	`bossBarPlayMusic`
`protected int`	`bossBarRange`
`protected int`	`bossBarRangeSq`
`protected AbstractBossBar.BarStyle`	`bossBarStyle`
`protected PlaceholderString`	`bossBarTitle`
`protected PlaceholderString`	`displayName`
`protected String`	`faction`
`protected List<PlaceholderString>`	`killMessages`
`protected double`	`lvlModArmor`
`protected double`	`lvlModAttackSpeed`
`protected double`	`lvlModDamage`
`protected double`	`lvlModHealth`
`protected double`	`lvlModKBR`
`protected double`	`lvlModPower`
`protected double`	`lvlModSpeed`
`protected BukkitEntityType`	`mobType`
`protected Optional<String>`	`mount`
`protected Optional<MPetCompat.MiniaturePetType>`	`mPetType`
`protected boolean`	`optionCollidable`
`protected boolean`	`optionDespawn`
`protected boolean`	`optionGlowing`
`protected boolean`	`optionInteractable`
`protected boolean`	`optionInvincible`
`protected Boolean`	`optionLockPitch`
`protected boolean`	`optionNoAI`
`protected boolean`	`optionNoGravity`
`protected boolean`	`optionPersistent`
`protected boolean`	`optionShowHealthInChat`
`protected boolean`	`optionSilent`
`protected Optional<String>`	`rider`
`protected double`	`spawnVelocityX`
`protected double`	`spawnVelocityXMax`
`protected boolean`	`spawnVelocityXRange`
`protected double`	`spawnVelocityY`
`protected double`	`spawnVelocityYMax`
`protected boolean`	`spawnVelocityYRange`
`protected double`	`spawnVelocityZ`
`protected double`	`spawnVelocityZMax`
`protected boolean`	`spawnVelocityZRange`
`protected String`	`strMobType`
`protected boolean`	`useBossBar`

Constructor Summary

Constructors
Constructor and Description

MythicMob(String file, String internalName, MythicConfig mc)
Constructor for mob types

Constructors
Constructor and Description
`MythicMob(String file, String internalName, MythicConfig mc)` Constructor for mob types

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActiveMob`	`applyMobOptions(ActiveMob am, double level)` Applies the options relating to this mob type to an entity
`ActiveMob`	`applyMobVolatileOptions(ActiveMob am)` Applies all volatile options relating to this mob type to an entity Volatile options must be applied after every server restart
`ActiveMob`	`applySpawnModifiers(ActiveMob am)` Applies Spawn Modifiers to the given mob for this mob type Spawn Modifiers are only applied when the mob is spawned
`int`	`compareTo(MythicMob mm)`
`boolean`	`equals(Object o)`
`void`	`executeSignalSkill(String signal, SkillMetadata data)`
`void`	`executeSkills(SkillTrigger cause, SkillMetadata data)`
`List<String>`	`getAIGoalSelectors()`
`List<String>`	`getAITargetSelectors()`
`PlaceholderDouble`	`getArmor()`
`protected double`	`getArmor(ActiveMob am)`
`double`	`getAttackSpeed(double level)`
`Optional<AbstractBossBar>`	`getBossBar()`
`int`	`getBossBarRangeSquared()`
`PlaceholderString`	`getBossBarTitle()`
`MythicConfig`	`getConfig()`
`PlaceholderDouble`	`getDamage()`
`double`	`getDamage(ActiveMob am)`
`boolean`	`getDespawns()` Gets whether this mob type despawns naturally
`PlaceholderString`	`getDisplayName()` Gets the display name of the mob type
`String`	`getEntityType()` Gets the string name of the entity type of the mob type
`String`	`getFaction()`
`String`	`getFile()` Gets the file name the mob type is located in
`PlaceholderDouble`	`getHealth()`
`double`	`getHealth(ActiveMob am)`
`String`	`getInternalName()` Gets the internal name of the mob type
`boolean`	`getIsInteractable()`
`boolean`	`getIsInvincible()`
`PlaceholderString`	`getKillMessage()`
`double`	`getKnockbackResistance(double level)`
`List<String>`	`getLevelModifiers()`
`double`	`getMovementSpeed(ActiveMob am)`
`BukkitEntityType`	`getMythicEntity()` Gets the MythicEntity object for the mob type
`double`	`getPerLevelArmor()`
`double`	`getPerLevelDamage()`
`double`	`getPerLevelHealth()` Gets the health scaling value of the mob type
`double`	`getPerLevelPower()`
`boolean`	`getShowHealthInChat()`
`boolean`	`getShowNameOnDamaged()`
`Queue<SkillMechanic>`	`getSkills(SkillTrigger trigger)`
`double`	`getSpawnVelocityX()`
`double`	`getSpawnVelocityY()`
`double`	`getSpawnVelocityZ()`
`boolean`	`getThreatTableDecaysUnreachable()`
`boolean`	`getThreatTableUseDamageTaken()`
`Queue<SkillMechanic>`	`getTimerSkills()`
`boolean`	`hasFaction()`
`boolean`	`hasKillMessages()`
`boolean`	`hasSkills(SkillTrigger trigger)`
`boolean`	`isPersistent()` Gets whether this mob type is removed by commands
`ActiveMob`	`spawn(AbstractLocation location, double level)` Spawns this mob type
`ActiveMob`	`spawn(AbstractLocation location, double level, SpawnReason reason)` Spawns this mob type
`String`	`toString()`
`boolean`	`usesBossBar()`
`boolean`	`usesImmunityTable()`
`boolean`	`usesThreatTable()`

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

Field Detail

strMobType
```
protected String strMobType
```

mobType
```
protected BukkitEntityType mobType
```

mPetType

protected Optional<MPetCompat.MiniaturePetType> mPetType

displayName

protected PlaceholderString displayName

faction
```
protected String faction
```

attrHealth
```
protected PlaceholderDouble attrHealth
```

attrDamage
```
protected PlaceholderDouble attrDamage
```

attrArmor
```
protected PlaceholderDouble attrArmor
```

attrMovementSpeed

protected PlaceholderDouble attrMovementSpeed

attrKnockbackResist
```
protected double attrKnockbackResist
```

attrFollowRange
```
protected double attrFollowRange
```

attrAttackSpeed
```
protected double attrAttackSpeed
```

lvlModDamage
```
protected double lvlModDamage
```

lvlModHealth
```
protected double lvlModHealth
```

lvlModArmor
```
protected double lvlModArmor
```

lvlModKBR
```
protected double lvlModKBR
```

lvlModPower
```
protected double lvlModPower
```

lvlModSpeed
```
protected double lvlModSpeed
```

lvlModAttackSpeed
```
protected double lvlModAttackSpeed
```

optionDespawn
```
protected boolean optionDespawn
```

optionPersistent
```
protected boolean optionPersistent
```

optionShowHealthInChat

protected boolean optionShowHealthInChat

optionSilent
```
protected boolean optionSilent
```

optionNoAI
```
protected boolean optionNoAI
```

optionGlowing
```
protected boolean optionGlowing
```

optionInvincible
```
protected boolean optionInvincible
```

optionCollidable
```
protected boolean optionCollidable
```

optionNoGravity
```
protected boolean optionNoGravity
```

optionInteractable
```
protected boolean optionInteractable
```

optionLockPitch
```
protected Boolean optionLockPitch
```

useBossBar
```
protected boolean useBossBar
```

bossBarRange
```
protected int bossBarRange
```

bossBarRangeSq
```
protected int bossBarRangeSq
```

bossBarTitle

protected PlaceholderString bossBarTitle

bossBarColor

protected AbstractBossBar.BarColor bossBarColor

bossBarStyle

protected AbstractBossBar.BarStyle bossBarStyle

bossBarCreateFog
```
protected boolean bossBarCreateFog
```

bossBarDarkenSky
```
protected boolean bossBarDarkenSky
```

bossBarPlayMusic
```
protected boolean bossBarPlayMusic
```

mount
```
protected Optional<String> mount
```

rider
```
protected Optional<String> rider
```

spawnVelocityX
```
protected double spawnVelocityX
```

spawnVelocityXMax
```
protected double spawnVelocityXMax
```

spawnVelocityY
```
protected double spawnVelocityY
```

spawnVelocityYMax
```
protected double spawnVelocityYMax
```

spawnVelocityZ
```
protected double spawnVelocityZ
```

spawnVelocityZMax
```
protected double spawnVelocityZMax
```

spawnVelocityXRange
```
protected boolean spawnVelocityXRange
```

spawnVelocityYRange
```
protected boolean spawnVelocityYRange
```

spawnVelocityZRange
```
protected boolean spawnVelocityZRange
```

killMessages

protected List<PlaceholderString> killMessages

Constructor Detail

MythicMob

public MythicMob(String file,
                 String internalName,
                 MythicConfig mc)

Constructor for mob types

Parameters:: file -; internalName -; mc -

Method Detail

getConfig
```
public MythicConfig getConfig()
```
Returns:

MythicConfig The configuration section for the mob

spawn
```
public ActiveMob spawn(AbstractLocation location,
                       double level)
```
Spawns this mob type

Parameters:

location - The location to spawn the mob at

level - The level of the mob to spawn

Returns:

ActiveMob The instance of the spawned mob

See Also:

ActiveMob

spawn
```
public ActiveMob spawn(AbstractLocation location,
                       double level,
                       SpawnReason reason)
```
Spawns this mob type

Parameters:

location - The location to spawn the mob at

level - The level of the mob to spawn

reason - The reason the mob is being spawned

Returns:

ActiveMob The instance of the spawned mob

See Also:

ActiveMob

applyMobOptions
```
public ActiveMob applyMobOptions(ActiveMob am,
                                 double level)
```
Applies the options relating to this mob type to an entity

Parameters:

am - The ActiveMob instance to apply the options to

level - The mob level to apply and scale with

Returns:

ActiveMob The updated ActiveMob instance

See Also:

ActiveMob

applyMobVolatileOptions
```
public ActiveMob applyMobVolatileOptions(ActiveMob am)
```
Applies all volatile options relating to this mob type to an entity Volatile options must be applied after every server restart

Parameters:

am - The ActiveMob instance to apply the options to

Returns:

ActiveMob The updated ActiveMob instance

See Also:

ActiveMob

applySpawnModifiers
```
public ActiveMob applySpawnModifiers(ActiveMob am)
```
Applies Spawn Modifiers to the given mob for this mob type Spawn Modifiers are only applied when the mob is spawned

Parameters:

am - The ActiveMob instance to apply the options to

Returns:

ActiveMob The updated ActiveMob instance

See Also:

ActiveMob

executeSkills

public void executeSkills(SkillTrigger cause,
                          SkillMetadata data)

executeSignalSkill

public void executeSignalSkill(String signal,
                               SkillMetadata data)

getSkills

public Queue<SkillMechanic> getSkills(SkillTrigger trigger)

hasSkills

public boolean hasSkills(SkillTrigger trigger)

getTimerSkills

public Queue<SkillMechanic> getTimerSkills()

getInternalName
```
public String getInternalName()
```
Gets the internal name of the mob type

Returns:

String

getFile
```
public String getFile()
```
Gets the file name the mob type is located in

Returns:

String

getDisplayName
```
public PlaceholderString getDisplayName()
```
Gets the display name of the mob type

Returns:

String

getEntityType
```
public String getEntityType()
```
Gets the string name of the entity type of the mob type

Returns:

String

getMythicEntity
```
public BukkitEntityType getMythicEntity()
```
Gets the MythicEntity object for the mob type

Returns:

MythicEntity

See Also:

BukkitEntityType

getDespawns
```
public boolean getDespawns()
```
Gets whether this mob type despawns naturally

Returns:

boolean

isPersistent
```
public boolean isPersistent()
```
Gets whether this mob type is removed by commands

Returns:

boolean

getPerLevelHealth
```
public double getPerLevelHealth()
```
Gets the health scaling value of the mob type

Returns:

double

getPerLevelDamage
```
public double getPerLevelDamage()
```

getPerLevelPower
```
public double getPerLevelPower()
```

getArmor
```
public PlaceholderDouble getArmor()
```

getPerLevelArmor
```
public double getPerLevelArmor()
```

getArmor

protected double getArmor(ActiveMob am)

getDamage
```
public PlaceholderDouble getDamage()
```

getDamage

public double getDamage(ActiveMob am)

getMovementSpeed

public double getMovementSpeed(ActiveMob am)

getKnockbackResistance

public double getKnockbackResistance(double level)

getAttackSpeed

public double getAttackSpeed(double level)

hasFaction
```
public boolean hasFaction()
```

getFaction
```
public String getFaction()
```

getHealth
```
public PlaceholderDouble getHealth()
```

getHealth

public double getHealth(ActiveMob am)

getIsInvincible
```
public boolean getIsInvincible()
```

usesThreatTable
```
public boolean usesThreatTable()
```

usesImmunityTable
```
public boolean usesImmunityTable()
```

getThreatTableUseDamageTaken

public boolean getThreatTableUseDamageTaken()

getThreatTableDecaysUnreachable

public boolean getThreatTableDecaysUnreachable()

getLevelModifiers

public List<String> getLevelModifiers()

getAIGoalSelectors

public List<String> getAIGoalSelectors()

getAITargetSelectors

public List<String> getAITargetSelectors()

hasKillMessages
```
public boolean hasKillMessages()
```

getKillMessage

public PlaceholderString getKillMessage()

getSpawnVelocityX
```
public double getSpawnVelocityX()
```

getSpawnVelocityY
```
public double getSpawnVelocityY()
```

getSpawnVelocityZ
```
public double getSpawnVelocityZ()
```

getIsInteractable
```
public boolean getIsInteractable()
```

usesBossBar
```
public boolean usesBossBar()
```

getBossBarRangeSquared
```
public int getBossBarRangeSquared()
```

getBossBar

public Optional<AbstractBossBar> getBossBar()

getBossBarTitle

public PlaceholderString getBossBarTitle()

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

compareTo
```
public int compareTo(MythicMob mm)
```
Specified by:

compareTo in interface Comparable<MythicMob>

getShowHealthInChat
```
public boolean getShowHealthInChat()
```

getShowNameOnDamaged
```
public boolean getShowNameOnDamaged()
```

Class MythicMob

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

strMobType

mobType

mPetType

displayName

faction

attrHealth

attrDamage

attrArmor

attrMovementSpeed

attrKnockbackResist

attrFollowRange

attrAttackSpeed

lvlModDamage

lvlModHealth

lvlModArmor

lvlModKBR

lvlModPower

lvlModSpeed

lvlModAttackSpeed

optionDespawn

optionPersistent

optionShowHealthInChat

optionSilent

optionNoAI

optionGlowing

optionInvincible

optionCollidable

optionNoGravity

optionInteractable

optionLockPitch

useBossBar

bossBarRange

bossBarRangeSq

bossBarTitle

bossBarColor

bossBarStyle

bossBarCreateFog

bossBarDarkenSky

bossBarPlayMusic

mount

rider

spawnVelocityX

spawnVelocityXMax

spawnVelocityY

spawnVelocityYMax

spawnVelocityZ

spawnVelocityZMax

spawnVelocityXRange

spawnVelocityYRange

spawnVelocityZRange

killMessages

Constructor Detail

MythicMob

Method Detail

getConfig

spawn

spawn

applyMobOptions

applyMobVolatileOptions

applySpawnModifiers

executeSkills

executeSignalSkill

getSkills

hasSkills

getTimerSkills

getInternalName

getFile

getDisplayName

getEntityType

getMythicEntity

getDespawns

isPersistent

getPerLevelHealth

getPerLevelDamage