### getPlugin() - AbstractCommand Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the plugin instance associated with an AbstractCommand. ```APIDOC ## getPlugin() ### Description Get the plugin instance. ### Method Method ### Endpoint com.ticxo.modelengine.api.command.AbstractCommand ### Parameters None ### Request Example None ### Response #### Success Response - **Plugin** - The plugin instance. ``` -------------------------------- ### get(String) Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Retrieves an item from a registry by its string key. This method is available in TRegistry and TSingletonRegistry. ```APIDOC ## get(String) ### Description Retrieves an item from a registry using its string key. ### Method Not specified (Class method) ### Endpoint Not specified (Class method) ### Parameters #### Path Parameters - **key** (String) - Required - The key of the item to retrieve. ### Response #### Success Response - (Type not specified) - The item associated with the key. ### Request Example Not specified. ``` -------------------------------- ### InteractionTicker Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/mananger/InteractionTicker.html Provides methods for managing model interactions, including starting the ticker, running its tasks, setting and getting relayed IDs, and managing model relays. ```APIDOC ## Class: InteractionTicker ### Description Manages player interactions with models, including relaying IDs and setting model relays. ### Methods #### `start()` - **Description**: Starts the interaction ticker. - **Return Type**: void #### `run()` - **Description**: The main task executed by the BukkitRunnable. - **Return Type**: void #### `setRelay(Player player, @Nullable Integer relayedId)` - **Description**: Sets the relayed ID for a player. - **Parameters**: - `player` (Player) - The player to set the relay for. - `relayedId` (Integer) - The ID to relay, can be null. - **Return Type**: void #### `getRelayedId(int id)` - **Description**: Gets the relayed ID for a given ID. - **Parameters**: - `id` (int) - The ID to retrieve the relayed ID for. - **Return Type**: Integer #### `setModelRelay(int id, UUID uuid)` - **Description**: Sets a model relay for a given ID. - **Parameters**: - `id` (int) - The ID to set the model relay for. - `uuid` (UUID) - The UUID of the model to relay. - **Return Type**: void #### `getModelRelay(int id)` - **Description**: Gets the model relay UUID for a given ID. - **Parameters**: - `id` (int) - The ID to retrieve the model relay UUID for. - **Return Type**: UUID ``` -------------------------------- ### WarnBoxUV Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/error/WarnBoxUV.html Initializes a new instance of the WarnBoxUV class. ```APIDOC ## WarnBoxUV() ### Description Initializes a new instance of the WarnBoxUV class. ### Constructor `public WarnBoxUV()` ``` -------------------------------- ### SoundKeyframe.Sounds Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/keyframe/type/SoundKeyframe.Sounds.html Initializes a new instance of the SoundKeyframe.Sounds class. ```APIDOC ## Sounds() ### Description Initializes a new instance of the SoundKeyframe.Sounds class. ### Constructor `Sounds()` ``` -------------------------------- ### ActiveModel.getModeledEntity Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/class-use/ModeledEntity.html Gets the owner of this model. ```APIDOC ## ActiveModel.getModeledEntity ### Description Get the owner of this model. ### Method `ModeledEntity` ### Response #### Success Response (200) - **ModeledEntity** - The owner of the model. ``` -------------------------------- ### getNetworkHandler() - NMSHandler Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the NetworkHandler from an NMSHandler. ```APIDOC ## getNetworkHandler() ### Description Get the NetworkHandler from this NMSHandler. ### Method Method ### Endpoint com.ticxo.modelengine.api.nms.NMSHandler ### Parameters None ### Request Example None ### Response #### Success Response - **NetworkHandler** - The NetworkHandler instance. ``` -------------------------------- ### tryApply Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/utils/CompatibilityManager.CompatibilityConfiguration.html Attempts to apply compatibility configurations for a given Bukkit plugin. This method is intended to be used within a lambda expression or method reference due to the functional interface nature of CompatibilityConfiguration. ```APIDOC ## tryApply ### Description Attempts to apply compatibility configurations for a given Bukkit plugin. ### Method `boolean` ### Parameters #### Path Parameters - **plugin** (org.bukkit.plugin.Plugin) - Required - The Bukkit plugin to apply compatibility settings for. ### Response #### Success Response (boolean) - Returns `true` if the compatibility settings were successfully applied, `false` otherwise. ### Request Example ```java CompatibilityManager.CompatibilityConfiguration config = (plugin) -> { // Your compatibility logic here return true; // or false based on success }; boolean applied = config.tryApply(yourBukkitPlugin); ``` ### Response Example ```json { "applied": true } ``` ``` -------------------------------- ### getNamespace() - ModelGenerator Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the namespace from a ModelGenerator. ```APIDOC ## getNamespace() ### Description Get the namespace of the model generator. ### Method Method ### Endpoint com.ticxo.modelengine.api.generator.ModelGenerator ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The namespace. ``` -------------------------------- ### MountInput Constructors Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/mount/controller/MountController.MountInput.html Provides details on how to instantiate the MountInput class. ```APIDOC ## MountInput() ### Description Default constructor for MountInput. ### Constructor `MountInput()` ## MountInput(float side, float front, boolean jump, boolean sneak) ### Description Constructs a new MountInput object with specified movement controls. ### Constructor `MountInput(float side, float front, boolean jump, boolean sneak)` ### Parameters #### Constructor Parameters - **side** (float) - The sideways movement input. - **front** (float) - The forward/backward movement input. - **jump** (boolean) - Indicates if the jump action is triggered. - **sneak** (boolean) - Indicates if the sneak action is triggered. ``` -------------------------------- ### getName() - AbstractCommand Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the name of an AbstractCommand. ```APIDOC ## getName() ### Description Get the name of the command. ### Method Method ### Endpoint com.ticxo.modelengine.api.command.AbstractCommand ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The name of the command. ``` -------------------------------- ### BukkitPlayer Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/entity/BukkitPlayer.html Initializes a new BukkitPlayer instance, wrapping a Bukkit Player entity. ```APIDOC ## Constructor BukkitPlayer ### Description Initializes a new BukkitPlayer instance. ### Parameters * **entity** (org.bukkit.entity.Player) - Required - The Bukkit Player entity to wrap. ``` -------------------------------- ### MountControllerRegistry Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/mount/MountControllerRegistry.html Initializes a new instance of the MountControllerRegistry class. ```APIDOC ## MountControllerRegistry() ### Description Initializes a new instance of the MountControllerRegistry class. ### Constructor `MountControllerRegistry()` ``` -------------------------------- ### getName() - SimpleProperty Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the name of a SimpleProperty. ```APIDOC ## getName() ### Description Get the name of the property. ### Method Method ### Endpoint com.ticxo.modelengine.api.animation.property.SimpleProperty ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The name of the property. ``` -------------------------------- ### get(Property) Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Retrieves a configuration value using a Property key. This method is part of the ConfigManager class. ```APIDOC ## get(Property) ### Description Retrieves a configuration value associated with the given Property key. ### Method Not specified (Class method) ### Endpoint Not specified (Class method) ### Parameters #### Path Parameters - **property** (Property) - Required - The configuration property to retrieve. ### Response #### Success Response - (Type not specified) - The configuration value. ### Request Example Not specified. ``` -------------------------------- ### getVelocity Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/nms/entity/impl/EmptyMoveController.html Gets the current velocity of the entity. ```APIDOC ## getVelocity() ### Description Gets the current velocity of the entity. ### Method `org.bukkit.util.Vector getVelocity()` ### Returns - **org.bukkit.util.Vector** - The current velocity of the entity. ``` -------------------------------- ### WarnBoneTooLarge Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/error/WarnBoneTooLarge.html Initializes a new instance of the WarnBoneTooLarge class. ```APIDOC ## Constructor ### WarnBoneTooLarge `public WarnBoneTooLarge()` Initializes a new instance of the `WarnBoneTooLarge` class. ``` -------------------------------- ### getEntityCounter Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/nms/entity/EntityHandler.html Gets the current entity counter. ```APIDOC ## getEntityCounter ### Description Gets the current entity counter. ### Method AtomicInteger ### Parameters None ``` -------------------------------- ### ScriptKeyframe.Script Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/keyframe/type/ScriptKeyframe.Script.html Initializes a new instance of the ScriptKeyframe.Script class. ```APIDOC ## ScriptKeyframe.Script() ### Description Initializes a new instance of the ScriptKeyframe.Script class. ### Constructor `Script()` ``` -------------------------------- ### DefaultStateHandler Methods using ModelState Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/state/class-use/ModelState.html Demonstrates how the DefaultStateHandler class interacts with ModelState, specifically for getting and setting properties associated with a given state. ```APIDOC ## DefaultStateHandler Interaction ### `DefaultStateHandler.Property getProperty(ModelState state)` Retrieves the property associated with a specific ModelState. ### `void setProperty(ModelState state, DefaultStateHandler.Property property)` Sets a property for a given ModelState. ``` -------------------------------- ### ModelEngineAPI.getMountPair Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/class-use/ModeledEntity.html Gets the model the passenger is riding on. ```APIDOC ## ModelEngineAPI.getMountPair ### Description Get the model the passenger is riding on. ### Method `static ModeledEntity` ### Parameters #### Path Parameters - **uuid** (UUID) - Required - The UUID of the passenger. ### Response #### Success Response (200) - **ModeledEntity** - The ModeledEntity of the vehicle being ridden. ``` -------------------------------- ### Quaternion Constructors Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/utils/math/Quaternion.html Provides information on how to instantiate a Quaternion object. ```APIDOC ## Quaternion(Quaternion copy) ### Description Creates a new Quaternion object as a copy of an existing one. ### Constructor `Quaternion(Quaternion copy)` ``` -------------------------------- ### getPhase() - IAnimationProperty Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the phase of an animation property. ```APIDOC ## getPhase() ### Description Get the phase of the animation property. ### Method Method ### Endpoint com.ticxo.modelengine.api.animation.property.IAnimationProperty ### Parameters None ### Request Example None ### Response #### Success Response - **float** - The phase of the property. ``` -------------------------------- ### Dummy Class Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/entity/Dummy.html This section details the methods available for direct use with the Dummy class, including methods for managing entity visibility, interaction, and physical properties. ```APIDOC ## Dummy Class Methods ### Description Provides methods for controlling entity spawning, despawning, interaction, and physical attributes. These methods are intended for direct use with Dummy instances. ### Methods - **`broadcastDespawnPacket()`** - Description: Called when the target becomes invisible. - Note: For bukkit entities and players, use `EntityHandler.broadcastDespawnPacket(BaseEntity, boolean)`. - **`broadcastSpawnPacket()`** - Description: Called when the target becomes visible again. - Note: For bukkit entities and players, use `EntityHandler.broadcastSpawnPacket(BaseEntity, boolean)`. - **`getItemInSlot(org.bukkit.inventory.EquipmentSlot slot)`** - Description: Retrieves the item in a specific equipment slot. - **`getOriginal()`** - Description: Get the wrapped target. - **`getStepHeight()`** - Description: Get the step height of this entity. - **`getWorld()`** - Description: Get the world of this entity. - **`onHurt(IDamageSource damageSource, float damage)`** - Description: Called when a sub-hitbox of this entity detects an attack. - Note: For default bukkit behavior, use `EntityHandler.hurt(Entity, IDamageSource, float)`. - **`onInteract(org.bukkit.entity.Player player, org.bukkit.inventory.EquipmentSlot hand)`** - Description: Called when a sub-hitbox of this entity detects an interaction. - Note: For default bukkit behavior, use `EntityHandler.interact(Entity, Player, EquipmentSlot)`. - **`onInteractAt(org.bukkit.entity.Player player, org.bukkit.inventory.EquipmentSlot hand, org.bukkit.util.Vector position)`** - Description: Called when a sub-hitbox of this entity detects an interaction at a specific position. - **`setCollidableToLiving(org.bukkit.entity.LivingEntity living, boolean flag)`** - Description: Configure whether the targeted living entity can collide with this entity. - **`setHitbox(Hitbox hitbox)`** - Description: Set the hitbox of this entity. - Note: For bukkit entities, use `EntityHandler.setHitbox(Entity, Hitbox)`. - **`setStepHeight(double height)`** - Description: Set the step height of this entity. - Note: For bukkit entities, use `EntityHandler.setStepHeight(Entity, double)`. - **`wrapBodyRotationControl()`** - Description: Create a wrapper for the body rotation control of this entity. - Note: For bukkit entities, wrap with `EntityHandler.wrapBodyRotationControl(Entity)`. - **`wrapLookControl()`** - Description: Create a wrapper for the look control of this entity. - Note: For bukkit entities, wrap with `EntityHandler.wrapLookControl(Entity)`. - **`wrapMoveControl()`** - Description: Create a wrapper for the movement control of this entity. - Note: For bukkit entities, wrap with `EntityHandler.wrapMoveControl(Entity)`. - **`wrapNavigation()`** - Description: Patch Minecraft's faulty pathfinding to accept different hitbox sizes. - Note: For bukkit entities, wrap with `EntityHandler.wrapNavigation(Entity)`. - **`wrapRangeManager(IModel model)`** - Description: Create a wrapper for the render range manager of this entity. - Note: For bukkit entities, wrap with `EntityHandler.wrapRangeManager(Entity)`. ``` -------------------------------- ### SimpleProperty Constructors Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/property/SimpleProperty.html Constructors for creating SimpleProperty instances. ```APIDOC ## SimpleProperty Constructor ### Description Initializes a new instance of the SimpleProperty class. ### Parameters * **model** (ActiveModel) - The active model associated with the animation. * **blueprintAnimation** (BlueprintAnimation) - The blueprint animation to be used. * **lerpIn** (double) - Optional. The interpolation factor for the start of the animation. * **lerpOut** (double) - Optional. The interpolation factor for the end of the animation. * **speed** (double) - Optional. The playback speed of the animation. ``` -------------------------------- ### getPath() - Property Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the path associated with a Property. ```APIDOC ## getPath() ### Description Get the path of the property. ### Method Method ### Endpoint com.ticxo.modelengine.api.utils.config.Property ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The path of the property. ``` -------------------------------- ### getPassengers() - BukkitPlayer Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets a list of passengers for a BukkitPlayer. ```APIDOC ## getPassengers() ### Description Get the passengers of this player. ### Method Method ### Endpoint com.ticxo.modelengine.api.entity.BukkitPlayer ### Parameters None ### Request Example None ### Response #### Success Response - **List** - A list of passengers. ``` -------------------------------- ### SoundKeyframe Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/keyframe/type/SoundKeyframe.html Constructs a new SoundKeyframe with the specified list of sounds. ```APIDOC ## SoundKeyframe Constructor ### Description Constructs a new SoundKeyframe with the specified list of sounds. ### Constructor `public SoundKeyframe(List value)` ### Parameters * **value** (List) - The list of sounds to associate with this keyframe. ``` -------------------------------- ### getSuggestions Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/command/CommandParser.TabCompleter.html This method is intended to be implemented by classes that provide command tab completion suggestions. It returns a list of possible string suggestions. ```APIDOC ## getSuggestions ### Description Provides command tab completion suggestions. ### Method `List getSuggestions()` ### Returns A list of strings representing the available suggestions. ``` -------------------------------- ### getPassengers() - BukkitEntity Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets a list of passengers for a BukkitEntity. ```APIDOC ## getPassengers() ### Description Get the passengers of this entity. ### Method Method ### Endpoint com.ticxo.modelengine.api.entity.BukkitEntity ### Parameters None ### Request Example None ### Response #### Success Response - **List** - A list of passengers. ``` -------------------------------- ### getPassengers() - BaseEntity Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets a list of passengers for a BaseEntity. ```APIDOC ## getPassengers() ### Description Get the passengers of this entity. ### Method Method ### Endpoint com.ticxo.modelengine.api.entity.BaseEntity ### Parameters None ### Request Example None ### Response #### Success Response - **List** - A list of passengers. ``` -------------------------------- ### createVFX(Player) - Static Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Creates a new VFX from a bukkit player. ```APIDOC ## createVFX(Player) ### Description Creates a new `VFX` from a bukkit player. ### Method Static method ### Endpoint N/A (Java method call) ### Parameters * **player** (Player) - The bukkit player. ### Request Example N/A (Java method call) ### Response * **VFX** - The newly created VFX instance. ``` -------------------------------- ### getParent() - ModelBone Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the parent bone of a ModelBone. ```APIDOC ## getParent() ### Description Get the parent bone of this bone. ### Method Method ### Endpoint com.ticxo.modelengine.api.model.bone.ModelBone ### Parameters None ### Request Example None ### Response #### Success Response - **ModelBone** - The parent bone. ``` -------------------------------- ### BukkitPlayer Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/entity/BukkitPlayer.html This section details the methods available on the BukkitPlayer class for managing player models. ```APIDOC ## BukkitPlayer Class Default implementation of `BaseEntity` to wrap the default bukkit's `Player` class. This is mainly used for players to disguise themselves as a model. ### Constructor `BukkitPlayer(@NotNull org.bukkit.entity.Player entity)` ### Methods - **broadcastDespawnPacket()** - Description: Called when the target becomes invisible. For bukkit entities and players, use `EntityHandler.broadcastDespawnPacket(BaseEntity, boolean)`. - Method: void - **broadcastSpawnPacket()** - Description: Called when the target becomes visible again. For bukkit entities and players, use `EntityHandler.broadcastSpawnPacket(BaseEntity, boolean)`. - Method: void - **getEntityId()** - Description: Get the entity ID of this entity. If the target is not a bukkit entity, you have to be absolutely sure that this ID does not overlap with an existing entity, as it is used to identify interactions between models. Use `EntityHandler.getEntityCounter()` to generate unique integer ID if you are unsure. - Method: int - **getItemInSlot(org.bukkit.inventory.EquipmentSlot slot)** - Description: Gets the item in the specified equipment slot. - Method: org.bukkit.inventory.ItemStack - **getLocation()** - Description: Get the location of this entity. - Method: org.bukkit.Location - **getPassengers()** - Description: Gets the passengers of this entity. - Method: List - **getUniqueId()** - Description: Get the UUID of this entity. This UUID is used to retrieve the instance of `ModeledEntity` associated with this entity. - Method: UUID - **getWorld()** - Description: Get the world of this entity. - Method: org.bukkit.World - **getXHeadRot()** - Description: Gets the X rotation of the entity's head. - Method: float - **getYBodyRot()** - Description: Gets the Y rotation of the entity's body. - Method: float - **getYHeadRot()** - Description: Gets the Y rotation of the entity's head. - Method: float - **isDead()** - Description: Checks if the entity is dead. - Method: boolean - **isGlowing()** - Description: Checks if the entity is glowing. - Method: boolean - **isMoving()** - Description: Checks if the entity is moving. - Method: boolean - **isOnGround()** - Description: Checks if the entity is on the ground. - Method: boolean - **onHurt(IDamageSource damageSource, float damage)** - Description: Called when a sub-hitbox of this entity detects an attack. For default bukkit behavior, use `EntityHandler.hurt(Entity, IDamageSource, float)`. - Method: boolean - **onInteract(org.bukkit.entity.Player player, org.bukkit.inventory.EquipmentSlot hand)** - Description: Called when a sub-hitbox of this entity detects an interaction. For default bukkit behavior, use `EntityHandler.interact(Entity, Player, EquipmentSlot)`. - Method: void - **setCollidableToLiving(org.bukkit.entity.LivingEntity living, boolean isRemove)** - Description: Configure whether the targeted living entity can collide with this entity. - Method: void - **setHitbox(Hitbox hitbox)** - Description: Set the hitbox of this entity. For bukkit entities, use `EntityHandler.setHitbox(Entity, Hitbox)`. - Method: void - **setStepHeight(double height)** - Description: Set the step height of this entity. For bukkit entities, use `EntityHandler.setStepHeight(Entity, double)`. - Method: void - **setYBodyRot(float rot)** - Description: Sets the Y rotation of the entity's body. - Method: void - **setYHeadRot(float rot)** - Description: Sets the Y rotation of the entity's head. - Method: void - **wrapBodyRotationControl()** - Description: Create a wrapper for the body rotation control of this entity. For bukkit entities, wrap with `EntityHandler.wrapBodyRotationControl(Entity)`. - Method: BodyRotationController - **wrapLookControl()** - Description: Create a wrapper for the look control of this entity. For bukkit entities, wrap with `EntityHandler.wrapLookControl(Entity)`. - Method: LookController - **wrapMoveControl()** - Description: Create a wrapper for the movement control of this entity. For bukkit entities, wrap with `EntityHandler.wrapMoveControl(Entity)`. - Method: MoveController - **wrapNavigation()** - Description: Patch Minecraft's faulty pathfinding to accept different hitbox sizes. For bukkit entities, wrap with `EntityHandler.wrapNavigation(Entity)`. - Method: void - **wrapRangeManager(IModel model)** - Description: Create a wrapper for the render range manager of this entity. For bukkit entities, wrap with `EntityHandler.wrapRangeManager(Entity)`. - Method: RangeManager ### Inherited Methods from class java.lang.Object `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` ``` -------------------------------- ### getNetworkHandler() - ModelEngineAPI Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Static method to get the NetworkHandler. ```APIDOC ## getNetworkHandler() ### Description Static method to get the NetworkHandler. ### Method Static Method ### Endpoint com.ticxo.modelengine.api.ModelEngineAPI ### Parameters None ### Request Example None ### Response #### Success Response - **NetworkHandler** - The NetworkHandler instance. ``` -------------------------------- ### BukkitPlayer.wrapLookControl() Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/nms/entity/wrapper/class-use/LookController.html Wraps the look control for a Bukkit player. ```APIDOC ## BukkitPlayer.wrapLookControl() ### Description Wraps the look control for a Bukkit player. ### Method [Method Signature] ### Parameters None ### Returns - `LookController` - The wrapped look controller. ``` -------------------------------- ### FakeEntity Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/nms/entity/fake/FakeEntity.html This section details the methods available for interacting with FakeEntity instances, including spawning, despawning, initialization, bone manipulation, and updates. ```APIDOC ## Interface FakeEntity ### Description Represents a fake entity in the ModelEngine system, allowing for programmatic control over its lifecycle and appearance. ### Methods #### `setBone(ModelBone bone)` * **Description**: Sets a specific bone for the fake entity. * **Parameters**: * `bone` (ModelBone) - The bone to set. #### `initialize()` * **Description**: Initializes the fake entity. #### `spawn()` * **Description**: Spawns the fake entity for all players. #### `spawn(org.bukkit.entity.Player player)` * **Description**: Spawns the fake entity for a specific player. * **Parameters**: * `player` (org.bukkit.entity.Player) - The player for whom to spawn the entity. #### `despawn()` * **Description**: Despawns the fake entity for all players. #### `despawn(org.bukkit.entity.Player player)` * **Description**: Despawns the fake entity for a specific player. * **Parameters**: * `player` (org.bukkit.entity.Player) - The player for whom to despawn the entity. #### `update()` * **Description**: Updates the fake entity. ### Fields #### `cloudOffset` * **Description**: A constant representing the offset for clouds associated with the fake entity. * **Type**: `double` * **Static**: `true` * **Final**: `true` ``` -------------------------------- ### getName() - IAnimationProperty Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the name of an animation property. ```APIDOC ## getName() ### Description Get the name of the animation property. ### Method Method ### Endpoint com.ticxo.modelengine.api.animation.property.IAnimationProperty ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The name of the property. ``` -------------------------------- ### Dummy Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/entity/Dummy.html The Dummy constructor is provided for advanced use cases. For general entity creation, it is recommended to use `ModelEngineAPI.createDummy()` or `ModelEngineAPI.createDummy(UUID)`. ```APIDOC ## Constructor Dummy ### Description Constructs a new Dummy entity. This constructor is intended for advanced usage and direct instantiation is generally discouraged. Prefer using the factory methods provided by `ModelEngineAPI`. ### Parameters * **entityId** (int) - The unique identifier for the entity. * **uuid** (UUID) - The universally unique identifier for the entity. ``` -------------------------------- ### getMsgId() - UnknownDamageSource Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the message ID from an UnknownDamageSource. ```APIDOC ## getMsgId() ### Description Get the message ID. ### Method Method ### Endpoint com.ticxo.modelengine.api.nms.world.UnknownDamageSource ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The message ID. ``` -------------------------------- ### create() Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/generator/BaseItemEnum.html Creates an ItemStack based on the enum constant. ```APIDOC ## create() Creates and returns an ItemStack corresponding to this enum constant. ### Returns An ItemStack representing this enum constant. ``` -------------------------------- ### getMsgId() - IDamageSource Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the message ID from an IDamageSource. ```APIDOC ## getMsgId() ### Description Get the message ID. ### Method Method ### Endpoint com.ticxo.modelengine.api.nms.world.IDamageSource ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The message ID. ``` -------------------------------- ### getSpeed Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/nms/entity/impl/EmptyMoveController.html Gets the movement speed attribute of the entity. ```APIDOC ## getSpeed() ### Description Gets the movement speed attribute of the entity. ### Method `float getSpeed()` ### Returns - **float** - The movement speed of the entity. ``` -------------------------------- ### ScriptReaderRegistry Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/script/ScriptReaderRegistry.html Initializes a new instance of the ScriptReaderRegistry class. This is a singleton, so direct instantiation is typically not needed. ```APIDOC ## ScriptReaderRegistry ### Description Initializes a new instance of the ScriptReaderRegistry class. This is a singleton, so direct instantiation is typically not needed. ### Constructor `ScriptReaderRegistry()` ``` -------------------------------- ### Get Modeled Entity Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/ActiveModel.html Retrieves the owner of the model. ```java ModeledEntity getModeledEntity() Get the owner of this model. ``` -------------------------------- ### execute Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/command/CommandParser.html Executes a command with the given target and arguments. ```APIDOC ## execute ### Description Executes a command with the given target and arguments. ### Method static void ### Signature execute(Object target, String... args) ### Parameters - **target** (Object) - The target object for the command. - **args** (String...) - The arguments for the command. ``` -------------------------------- ### AbstractObjectKeyframe Constructors Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/animation/keyframe/AbstractObjectKeyframe.html Provides constructors for initializing AbstractObjectKeyframe instances. ```APIDOC ## AbstractObjectKeyframe Constructors ### AbstractObjectKeyframe(T value) **Description**: Initializes an AbstractObjectKeyframe with a given value. ### AbstractObjectKeyframe(T value, KeyframeType type) **Description**: Initializes an AbstractObjectKeyframe with a given value and keyframe type. ``` -------------------------------- ### getPosition() - VFX Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the position of a Visual Effect (VFX). ```APIDOC ## getPosition() ### Description Get the position of this VFX. ### Method Method ### Endpoint com.ticxo.modelengine.api.model.vfx.VFX ### Parameters None ### Request Example None ### Response #### Success Response - **Vector3f** - The position of the VFX. ``` -------------------------------- ### getPosition() - ModelBone Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the position of a ModelBone in 3D space. ```APIDOC ## getPosition() ### Description Get the position of this bone in 3D space. ### Method Method ### Endpoint com.ticxo.modelengine.api.model.bone.ModelBone ### Parameters None ### Request Example None ### Response #### Success Response - **Vector3f** - The position of the bone. ``` -------------------------------- ### Dummy Entity Creation Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/ModelEngineAPI.html Methods for creating dummy entities, which are primarily used for spawning player-specific models. ```APIDOC ## createDummy ### Description Creates a new `Dummy` entity. This can be created with a random UUID or a specific UUID. ### Method `static Dummy createDummy()` `static Dummy createDummy(UUID uuid)` ### Parameters * `uuid` (UUID) - Optional - The specific UUID to assign to the dummy entity. If not provided, a random UUID will be generated. ``` -------------------------------- ### spawn() Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Spawns the model into the world, making it visible to all nearby players. This method is available for ActiveModel, ModelBone, FakeEntity, and ModelHitbox. ```APIDOC ## spawn() ### Description Spawns the model into the world. This method makes the model visible to all players within proximity. It is applicable to ActiveModel, ModelBone, FakeEntity, and ModelHitbox interfaces/classes. ### Method This is a method signature, not an HTTP endpoint. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response None #### Response Example None ``` -------------------------------- ### BukkitEntity Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/entity/BukkitEntity.html Constructs a new BukkitEntity, wrapping a given Bukkit Entity. ```APIDOC ## BukkitEntity(Entity entity) ### Description Constructs a new BukkitEntity instance. ### Parameters #### Path Parameters - **entity** (org.bukkit.entity.Entity) - Required - The Bukkit entity to wrap. ``` -------------------------------- ### getPermissionNode() - AbstractCommand Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the permission node required for an AbstractCommand. ```APIDOC ## getPermissionNode() ### Description Permission node for this command. ### Method Method ### Endpoint com.ticxo.modelengine.api.command.AbstractCommand ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The permission node. ``` -------------------------------- ### getPassengers() - MountPoint Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets a list of passengers riding on a MountPoint. ```APIDOC ## getPassengers() ### Description Get the passengers riding on this mount point. ### Method Method ### Endpoint com.ticxo.modelengine.api.nms.entity.fake.MountPoint ### Parameters None ### Request Example None ### Response #### Success Response - **List** - A list of passengers. ``` -------------------------------- ### WarnNoHitbox Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/error/WarnNoHitbox.html Constructs a new WarnNoHitbox instance. This is a default constructor and does not take any arguments. ```APIDOC ## Constructor ### WarnNoHitbox `public WarnNoHitbox()` **Description:** Initializes a new instance of the `WarnNoHitbox` class. This constructor is used to create a warning object when no hitbox is detected for a model. ``` -------------------------------- ### Quaternion Instance Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/utils/math/Quaternion.html Details instance methods for manipulating Quaternion objects. ```APIDOC ## Quaternion add(Quaternion other) ### Description Adds another Quaternion to this Quaternion. ### Method `Quaternion add(Quaternion other)` ``` ```APIDOC ## Quaternion mul(double value) ### Description Multiplies this Quaternion by a scalar value. ### Method `Quaternion mul(double value)` ``` ```APIDOC ## Quaternion mul(Quaternion other) ### Description Multiplies this Quaternion by another Quaternion. ### Method `Quaternion mul(Quaternion other)` ``` ```APIDOC ## Quaternion normalize() ### Description Normalizes this Quaternion to have a magnitude of 1. ### Method `Quaternion normalize()` ``` ```APIDOC ## double dot(Quaternion other) ### Description Calculates the dot product between this Quaternion and another. ### Method `double dot(Quaternion other)` ``` ```APIDOC ## Quaternion altAdd(Quaternion other) ### Description Adds another Quaternion to this Quaternion (alternative method). ### Method `Quaternion altAdd(Quaternion other)` ``` ```APIDOC ## Quaternion altMul(Quaternion other) ### Description Multiplies this Quaternion by another Quaternion (alternative method). ### Method `Quaternion altMul(Quaternion other)` ``` ```APIDOC ## Quaternion altMul(double value) ### Description Multiplies this Quaternion by a scalar value (alternative method). ### Method `Quaternion altMul(double value)` ``` ```APIDOC ## Quaternion conjugate() ### Description Calculates the conjugate of this Quaternion. ### Method `Quaternion conjugate()` ``` ```APIDOC ## Quaternion altConjugate() ### Description Calculates the conjugate of this Quaternion (alternative method). ### Method `Quaternion altConjugate()` ``` ```APIDOC ## Quaternion copy() ### Description Creates a copy of this Quaternion. ### Method `Quaternion copy()` ``` ```APIDOC ## org.bukkit.util.EulerAngle toEulerAngle() ### Description Converts this Quaternion to a Bukkit EulerAngle object. ### Method `org.bukkit.util.EulerAngle toEulerAngle()` ``` -------------------------------- ### getPassengers() - MountManager Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets a list of passengers managed by the MountManager. ```APIDOC ## getPassengers() ### Description Get the passengers managed by this MountManager. ### Method Method ### Endpoint com.ticxo.modelengine.api.mount.MountManager ### Parameters None ### Request Example None ### Response #### Success Response - **List** - A list of passengers. ``` -------------------------------- ### ServerInfo Class Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/ServerInfo.html Provides static information about the server environment. ```APIDOC ## Class ServerInfo Provides static information about the server environment. ### Fields - **IS_PAPER** (boolean) - `static final` - Indicates if the server is running on PaperMC. ### Constructors - **ServerInfo()** - Default constructor. ``` -------------------------------- ### getPackFolder() - ModelGenerator Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the pack folder path from a ModelGenerator. ```APIDOC ## getPackFolder() ### Description Get the pack folder path. ### Method Method ### Endpoint com.ticxo.modelengine.api.generator.ModelGenerator ### Parameters None ### Request Example None ### Response #### Success Response - **String** - The path to the pack folder. ``` -------------------------------- ### getOriginal() - BaseEntity Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the wrapped target entity from a BaseEntity. ```APIDOC ## getOriginal() ### Description Get the wrapped target. ### Method Method ### Endpoint com.ticxo.modelengine.api.entity.BaseEntity ### Parameters None ### Request Example None ### Response #### Success Response - **BaseEntity** - The original wrapped entity. ``` -------------------------------- ### createDummy Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/ModelEngineAPI.html Creates a new Dummy instance, which is primarily used for spawning player-specific models. This method is overloaded to allow creation with either a random UUID or a specific UUID. ```APIDOC ## createDummy (Random UUID) ### Description Create a new `Dummy` with a random UUID. This is mainly used to spawn player-specific models. ### Method public static Dummy createDummy() ### Response #### Success Response - Returns the created instance of a `Dummy`. ``` ```APIDOC ## createDummy (Specific UUID) ### Description Create a new `Dummy` with a specific UUID. This is mainly used to spawn player-specific models. ### Method public static Dummy createDummy(UUID uuid) ### Parameters #### Path Parameters - **uuid** (UUID) - Required - the specific UUID for the Dummy instance. ### Response #### Success Response - Returns the created instance of a `Dummy`. ``` -------------------------------- ### Matrix3x3 Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/utils/math/Matrix3x3.html Provides documentation for various methods of the Matrix3x3 class, including setting rows/columns, retrieving rows/columns, conversions, and matrix multiplication. ```APIDOC ## setRow(int row, org.bukkit.util.Vector vector) ### Description Sets a specific row of the matrix using a Vector. ### Method `void setRow(int row, org.bukkit.util.Vector vector)` ``` ```APIDOC ## setRow(int row, double x, double y, double z) ### Description Sets a specific row of the matrix using individual coordinate values. ### Method `void setRow(int row, double x, double y, double z)` ``` ```APIDOC ## setColumn(int col, org.bukkit.util.Vector vector) ### Description Sets a specific column of the matrix using a Vector. ### Method `void setColumn(int col, org.bukkit.util.Vector vector)` ``` ```APIDOC ## setColumn(int col, double x, double y, double z) ### Description Sets a specific column of the matrix using individual coordinate values. ### Method `void setColumn(int col, double x, double y, double z)` ``` ```APIDOC ## getRow(int row) ### Description Retrieves a specific row of the matrix as a Vector. ### Method `org.bukkit.util.Vector getRow(int row)` ``` ```APIDOC ## getColumn(int col) ### Description Retrieves a specific column of the matrix as a Vector. ### Method `org.bukkit.util.Vector getColumn(int col)` ``` ```APIDOC ## toEulerAngle() ### Description Converts the matrix to an EulerAngle. ### Method `org.bukkit.util.EulerAngle toEulerAngle()` ``` ```APIDOC ## toQuaternion() ### Description Converts the matrix to a Quaternion. ### Method `Quaternion toQuaternion()` ``` ```APIDOC ## multiply(Matrix3x3 lhs, Matrix3x3 rhs) ### Description Performs matrix multiplication between two Matrix3x3 instances. ### Method `static Matrix3x3 multiply(Matrix3x3 lhs, Matrix3x3 rhs)` ``` ```APIDOC ## rotationAlign(org.bukkit.util.Vector from, org.bukkit.util.Vector to) ### Description Creates a Matrix3x3 that represents the rotation to align one vector to another. ### Method `static Matrix3x3 rotationAlign(org.bukkit.util.Vector from, org.bukkit.util.Vector to)` ``` ```APIDOC ## fromEulerAngle(org.bukkit.util.EulerAngle angle) ### Description Creates a Matrix3x3 from an EulerAngle. ### Method `static Matrix3x3 fromEulerAngle(org.bukkit.util.EulerAngle angle)` ``` ```APIDOC ## fromQuaternion(Quaternion q) ### Description Creates a Matrix3x3 from a Quaternion. ### Method `static Matrix3x3 fromQuaternion(Quaternion q)` ``` -------------------------------- ### getInteractionTicker() Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Gets the interaction ticker from the ModelEngineAPI. This is a static method. ```APIDOC ## getInteractionTicker() ### Description Gets the interaction ticker. ### Method Static Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response #### Success Response - **Object**: The interaction ticker. ### Response Example N/A ``` -------------------------------- ### Matrix3x3 Constructor Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/utils/math/Matrix3x3.html Initializes a new instance of the Matrix3x3 class with default values. ```APIDOC ## Matrix3x3() ### Description Initializes a new instance of the Matrix3x3 class. ### Constructor `Matrix3x3()` ``` -------------------------------- ### Get Leash Handler Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/ActiveModel.html Retrieves the handler for all leash bones. ```java LeashHandler getLeashHandler() Get the handler for all leash bones. ``` -------------------------------- ### BukkitEntity.wrapLookControl() Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/nms/entity/wrapper/class-use/LookController.html Wraps the look control for a Bukkit entity. ```APIDOC ## BukkitEntity.wrapLookControl() ### Description Wraps the look control for a Bukkit entity. ### Method [Method Signature] ### Parameters None ### Returns - `LookController` - The wrapped look controller. ``` -------------------------------- ### Get Nametag Handler Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/ActiveModel.html Retrieves the handler for all nametag bones. ```java NametagHandler getNametagHandler() Get the handler for all nametag bones. ``` -------------------------------- ### Get Blueprint Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/ActiveModel.html Retrieves the blueprint used to generate this model. ```java ModelBlueprint getBlueprint() Get the blueprint used to generate this model. ``` -------------------------------- ### Mountable Interface Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/bone/Mountable.html This section details the methods available on the Mountable interface for managing mounted entities. ```APIDOC ## Interface Mountable `Mountable` is an interface that extends `ModelBone`, representing a bone on a model that can have entities mounted to it. ### Methods #### `getMountPoint()` * **Description**: Retrieves the `MountPoint` associated with this bone. * **Returns**: `MountPoint` - The mount point of the bone. #### `isDriverBone()` * **Description**: Checks if this bone is designated as the driver bone for mounting. * **Returns**: `boolean` - `true` if it's a driver bone, `false` otherwise. #### `mountRiders(org.bukkit.entity.Entity... entities)` * **Description**: Mounts one or more entities onto this bone. * **Parameters**: * `entities` (org.bukkit.entity.Entity...) - The entities to mount. #### `dismountRider(org.bukkit.entity.Entity entity)` * **Description**: Dismounts a specific entity from this bone. * **Parameters**: * `entity` (org.bukkit.entity.Entity) - The entity to dismount. #### `clearRiders()` * **Description**: Dismounts all entities currently mounted on this bone. #### `getRiders()` * **Description**: Retrieves a set of all entities currently mounted on this bone. * **Returns**: `Set` - A set containing the mounted entities. ``` -------------------------------- ### wrapAll(Runnable runnable) Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/utils/RaceConditionUtil.html Safely executes a Runnable. If an error occurs during execution, it will retry after a delay of 1 tick. ```APIDOC ## wrapAll(Runnable runnable) ### Description Safely executes a Runnable. If an error occurs during execution, it will retry after a delay of 1 tick. ### Method ```java public static void wrapAll(Runnable runnable) ``` ### Parameters * `runnable` - The Runnable task to execute. ``` -------------------------------- ### ModelBone - Get ActiveModel Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/model/class-use/ActiveModel.html Retrieves the ActiveModel associated with a ModelBone. ```APIDOC ## ModelBone - getActiveModel ### Description Gets the `ActiveModel` that this `ModelBone` belongs to. ### Method #### `ActiveModel getActiveModel()` - **Returns**: The `ActiveModel` instance associated with this bone. ``` -------------------------------- ### getName Source: https://ticxo.github.io/Model-Engine-Javadocs/com/ticxo/modelengine/api/command/AbstractCommand.html Abstract method to get the name of the command or subcommand. ```APIDOC ## abstract String getName() ### Returns (String) - The name of this command (or subcommand) ``` -------------------------------- ### BukkitEntity Methods Source: https://ticxo.github.io/Model-Engine-Javadocs/index-all.html Methods specific to Bukkit entities. ```APIDOC ## setStepHeight(double) ### Description Sets the step height of this entity. ### Method N/A (Java Method Signature) ### Endpoint N/A ## setYBodyRot(float) ### Description Sets the Y body rotation of this entity. ### Method N/A (Java Method Signature) ### Endpoint N/A ## setYHeadRot(float) ### Description Sets the Y head rotation of this entity. ### Method N/A (Java Method Signature) ### Endpoint N/A ```