Cobblemon Wiki - User contributions [en]

Molang Entity Functions

2025-09-26T02:22:10Z

JPAKx4:

Type is <code>ObjectValue<LivingEntity></code>.

{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Must be called on
|-
|<syntaxhighlight lang="kotlin">uuid(): String</syntaxhighlight>
|Returns the UUID of the entity.
|<syntaxhighlight lang="kotlin">v.entity.uuid()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">damage(amount: Double)</syntaxhighlight>
|Deals damage equal to <code>amount</code>. Damage type is generic.
|<syntaxhighlight lang="kotlin">v.entity.damage(5)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">walk_to(x: Double, y: Double, z: Double, speedMultiplier: Double?)</syntaxhighlight>
|If the entity is a <code>PathfinderMob</code> then the mob will change its target to the <code>x</code>, <code>y</code>, and <code>z</code>. <code>speedMultiplier</code> is <code>0.35</code> by default.
|<syntaxhighlight lang="kotlin">v.entity.walk_to(0, 0, 0)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">has_walk_target(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is a <code>PathfinderMob</code> and has a walk target or is currently pathfinding. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.has_walk_target()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_sneaking(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is sneaking. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_sneaking()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_sprinting(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is sprinting. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_sprinting()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_flying(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is flying. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_flying()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_in_water(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is in water. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_in_water()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_touching_water_or_rain(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is touching water or rain. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_touching_water_or_rain()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_touching_water(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is touching water. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_touching_water()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_underwater(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is underwater. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_under_water()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_in_lava(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is in lava. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_in_lava()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_on_fire(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is on fire. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_on_fire()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_invisible(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is invisible. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_invisible()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_sleeping(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is sleeping. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_sleeping()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_riding(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is riding. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_riding()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">health(): Double</syntaxhighlight>
|Returns the current health of the entity.
|<syntaxhighlight lang="kotlin">v.entity.health()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">distance_to_pos(x: Double, y: Double, z: Double): Double</syntaxhighlight>
|Returns the distance from the entity to the position at <code>x</code>, <code>y</code>, and <code>z</code>. Pythagoras baby!
|<syntaxhighlight lang="kotlin">v.entity.distance_to_pos(0, 0, 0)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">max_health(): Double</syntaxhighlight>
|Returns the max health of the entity.
|<syntaxhighlight lang="kotlin">v.entity.max_health()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">name(): String</syntaxhighlight>
|Returns the name of the entity.
|<syntaxhighlight lang="kotlin">v.entity.name()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">type(): MoValue</syntaxhighlight>
|Returns the type of the entity as a string if it is registered. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.type()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">yaw(): Double</syntaxhighlight>
|Returns the yaw of the entity.
|<syntaxhighlight lang="kotlin">v.entity.yaw()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">pitch(): Double</syntaxhighlight>
|Returns the pitch of the entity.
|<syntaxhighlight lang="kotlin">v.entity.pitch()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">x(): Double</syntaxhighlight>
|Returns the x position of the entity.
|<syntaxhighlight lang="kotlin">v.entity.x()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">y(): Double</syntaxhighlight>
|Returns the y position of the entity.
|<syntaxhighlight lang="kotlin">v.entity.y()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">z(): Double</syntaxhighlight>
|Returns the z position of the entity.
|<syntaxhighlight lang="kotlin">v.entity.z()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">velocity_x(): Double</syntaxhighlight>
|Returns the x velocity of the entity.
|<syntaxhighlight lang="kotlin">v.entity.velocity_x()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">velocity_y(): Double</syntaxhighlight>
|Returns the y velocity of the entity.
|<syntaxhighlight lang="kotlin">v.entity.velocity_y()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">velocity_z(): Double</syntaxhighlight>
|Returns the z velocity of the entity.
|<syntaxhighlight lang="kotlin">v.entity.velocity_z()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">width(): Double</syntaxhighlight>
|Returns the width of the entity.
|<syntaxhighlight lang="kotlin">v.entity.width()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">height(): Double</syntaxhighlight>
|Returns the height of the entity.
|<syntaxhighlight lang="kotlin">v.entity.height()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">entity_size(): Double</syntaxhighlight>
|Returns the larger dimension between the xsize and the ysize of the entity.
|<syntaxhighlight lang="kotlin">v.entity.entity_size()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">entity_width(): Double</syntaxhighlight>
|Returns the width of the entity.
|<syntaxhighlight lang="kotlin">v.entity.entity_width()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">entity_height(): Double</syntaxhighlight>
|Returns the height of the entity.
|<syntaxhighlight lang="kotlin">v.entity.entity_height()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">id_modulo(modValue: Double): Double</syntaxhighlight>
|Returns the value of the entities' UUID mod <code>modValue</code>.
|<syntaxhighlight lang="kotlin">v.entity.id_modulo(32)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">horizontal_velocity(): Double</syntaxhighlight>
|Returns the horizontal velocity of the entity.
|<syntaxhighlight lang="kotlin">v.entity.horizontal_velocity()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">vertical_velocity(): Double</syntaxhighlight>
|Returns the vertical velocity of the entity.
|<syntaxhighlight lang="kotlin">v.entity.vertical_velocity()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">world(): ObjectValue<Holder<Level>></syntaxhighlight>
|Returns the world that the entity is in as a <code>ObjectValue<Holder<Level>></code>.
|<syntaxhighlight lang="kotlin">v.entity.world()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">biome(): ObjectValue<Holder<Biome>></syntaxhighlight>
|Returns the biome that the entity is in as a <code>ObjectValue<Holder<Biome>>.
|<syntaxhighlight lang="kotlin">v.entity.biome()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_passenger(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the entity is invisible. Otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_passenger()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_healer_in_use(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Returns if the healing machine at <code>position</code> is in use. Uses the entities' level. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.is_healer_in_use(0, 0, 0)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">find_nearby_block(identifier: String, range: Double?): MoValue</syntaxhighlight>
|Looks for a block within a cube with size <code>range</code> centered around the entity, with a default of <code>10<code>. Identifier namespace is <code>minecraft</code> by default. Returns <code>0.0</code> if block cannot be found or an <code>ArrayStruct<Int></code> for the position of the block.
|<syntaxhighlight lang="kotlin">v.entity.find_nearby_block('cobblemon:restoration_tank')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">get_nearby_entities(distance: Double): ArrayStruct<MoValue></syntaxhighlight>
|Get entities within a cube with size <code>distance</code> centered around the entity. Returns an <code>ArrayStruct</code> with the most specific type, such as <code>ObjectValue<Player></code>, <code>ObjectValue<NPCEntity></code>, or <code>ObjectValue<LivingEntity></code>.
|<syntaxhighlight lang="kotlin">v.entity.get_nearby_entities(10)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_standing_on_blocks(depth: Int, blocks, ResourceLocation...): Double</syntaxhighlight>
|If the entity is standing on any of the supplied <code>blocks</code> then the funtion returns <code>1.0</code>, othewise returns <code>0.0</code>
|<syntaxhighlight lang="kotlin">v.entity.is_standing_on_blocks(2, 'dirt', 'cobblemon:apricorn_log')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">play_animation(animation: String, target: String?): DoubleValue</syntaxhighlight>
|Plays an animation on an entity by the name <code>animation</code>. If <code>target</code> is not specified or null then all nearby entities will get the animation packet. If <code>target</code> is either a player name or UUID then the packet will be sent to them only. Returns <code>1.0</code> if packet(s) are sent, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.entity.play_animation('sleep')</syntaxhighlight>
|PoseableEntities
|-
|<syntaxhighlight lang="kotlin">spawn_bedrock_particles(effect: String, locator: String, player: MoValue?)</syntaxhighlight>
|Sends bedrock particles of the resource <code>effect</code> and <code>locator</code> to players around the entity, or to <code>player</code> only. <code>player</code> can either be a UUID or a <code>ObjectValue<Player></code>. Locator is required, even if unused on non-poseable entities.
|<syntaxhighlight lang="kotlin">q.entity.spawn_bedrock_particles('cobblemon:cherry_leaves_particle', 'middle')</syntaxhighlight>
|
|}

Molang

2025-04-20T00:39:11Z

JPAKx4:

Cobblemon uses a [https://github.com/Hiroku/MoLang/ modified] version of [https://github.com/bedrockk/MoLang Bedrockk MoLang] to parse and execute MoLang. Updated as of 1.6.1.

==Types==

* [[Molang Types|Types]]

==Functions==

* [[Molang General Functions|General (Standard) Functions]]
* [[Molang Registry Functions|Registry Functions (World, Block, Dimension, Biome)]]
* [[Molang Player Functions|Player Functions]]
* [[Molang Entity Functions|Entity Functions]]
* [[Molang NPC Functions|NPC Functions]]
* [[Molang Battle Functions|Battle Functions]]
* [[Molang BattleActor Functions|BattleActor Functions]]
* [[Molang Pokémon Functions|Pokémon Functions]]
* [[Molang PokémonEntity Functions|PokémonEntity Functions]]
* [[Molang PokémonStore Functions|PokémonStore Functions]]
* [[Molang Party Functions|Party Functions]]
* [[Molang PC Functions|PC Functions]]
* [[Molang SpawningContext Functions|SpawningContext Functions]]
* [[Molang Server Functions|Server Functions]]
* [[Molang Pokédex Functions|Pokédex Functions]]
* [[Molang Species Functions|Species Functions]]

==== Client Only ====

* [[Molang Client General Functions|General Functions]]
* [[Molang Animation Functions|Animation Functions]]

Molang

2025-04-19T23:14:48Z

JPAKx4: Added main MoLang documentation page

Cobblemon uses [https://github.com/bedrockk/MoLang Bedrockk MoLang] to parse and execute MoLang. Updated as of 1.6.1.

==Types==

* [[Molang Types|Types]]

==Functions==

* [[Molang General Functions|General (Standard) Functions]]
* [[Molang Registry Functions|Registry Functions (World, Block, Dimension, Biome)]]
* [[Molang Player Functions|Player Functions]]
* [[Molang Entity Functions|Entity Functions]]
* [[Molang NPC Functions|NPC Functions]]
* [[Molang Battle Functions|Battle Functions]]
* [[Molang BattleActor Functions|BattleActor Functions]]
* [[Molang Pokémon Functions|Pokémon Functions]]
* [[Molang PokémonEntity Functions|PokémonEntity Functions]]
* [[Molang PokémonStore Functions|PokémonStore Functions]]
* [[Molang Party Functions|Party Functions]]
* [[Molang PC Functions|PC Functions]]
* [[Molang SpawningContext Functions|SpawningContext Functions]]
* [[Molang Server Functions|Server Functions]]
* [[Molang Pokédex Functions|Pokédex Functions]]
* [[Molang Species Functions|Species Functions]]

==== Client Only ====

* [[Molang Client General Functions|General Functions]]
* [[Molang Animation Functions|Animation Functions]]

Molang Animation Functions

2025-04-19T23:13:47Z

JPAKx4: Fixed formatting

Type is <code>QueryStruct<PoseableModel></code>.
{| class="wikitable fixed-header sortable"
|<syntaxhighlight lang="kotlin">exclude_labels(): ObjectValue<ExcludedLabels></syntaxhighlight>
|Returns an <code>ObjectValue<ExcludedLabels></code> from a <code>PoseableModel</code>.
|<syntaxhighlight lang="kotlin">v.model.exclude_labels()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_primary(group: String, animation: String, options: MoValue...): ObjectValue<PrimaryAnimation></syntaxhighlight>
|Creates a new <code>PrimaryAnimation</code> using the <code>group</code> and <code>animation</code>. The <code>options</code> can either be <code>ExcludedLabels</code>, a <code>WaveFunction</code> (only the last one is used), or a String that represents a label to exclude. Returns an <code>ObjectValue<PrimaryAnimation></code> of the newly created <code>PrimaryAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_stateful(group: String, animation: String, enduresPrimary: IDK WHAT THIS IS): ObjectValue<BedrockActiveAnimation></syntaxhighlight>
|Creates a new <code>BedrockActiveAnimation</code> using the <code>group</code> and <code>animation</code>. IDK WHAT EDURESPRIMARY IS. Returns an <code>ObjectValue<BedrockActiveAnimation></code> of the newly created <code>BedrockActiveAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock(group: String, animation: String): ObjectValue<BedrockPoseAnimation></syntaxhighlight>
|Creates a new <code>BedrockPoseAnimation</code> using the <code>group</code> and <code>animation</code>. Returns an <code>ObjectValue<BedrockActiveAnimation></code> of the newly created <code>BedrockActiveAnimation</code>.
|<syntaxhighlight lang="kotlin">
I don't know what is an example
</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">look(boneName: String, pitchMultiplier: Double?, yawMulitplier: Double?, maxPitch: Double?, minPitch: Double?, maxYaw, Double?, minYaw: Double?): ObjectValue<SingleBoneLookAnimation></syntaxhighlight>
|Creates a new <code>SingleBoneLookAnimation</code> using the <code>boneName</code> and other options. Returns an <code>ObjectValue<SingleBoneLookAnimation></code> of the newly created <code>SingleBoneLookAnimation</code>. The default values are in order here: <code>1.0, 1.0, 70.0, -45.0, 45.0, -45.0</code>.
|<syntaxhighlight lang="kotlin">v.model.look('head')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">quadruped_walk(periodMultiplier: Double?, amplitudeMultiplier: Double? leftFrontLeftName: String?, leftFrontRightName: String?, leftBackLeftName: String?. leftBackRightName: String?): ObjectValue<QuadrupedWalkAnimation></syntaxhighlight>
|Creates a new <code>QuadrupedWalkAnimation</code> using the options. Returns an <code>ObjectValue<QuadrupedWalkAnimation></code> of the newly created <code>QuadrupedWalkAnimation</code>. The default values are in order here: <code>0.6662, 1.4, 'leg_front_left', leg_front_right', 'leg_back_left', 'leg_back_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.quadruped_walk()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">biped_walk(periodMultiplier: Double?, amplitudeMultiplier: Double? leftLegName?: String, rightLegName: String?): ObjectValue<BipedWalkAnimation></syntaxhighlight>
|Creates a new <code>BipedWalkAnimation</code> using the options. Returns an <code>ObjectValue<BipedWalkAnimation></code> of the newly created <code>BipedWalkAnimation</code>. The default values are in order here: <code>0.6662, 1.4, 'leg_left', 'leg_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.biped_walk()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bimanual_swing(periodMultiplier: Double?, amplitudeMultiplier: Double? leftArmName: String?, rightArmName String?): ObjectValue<BimanualSwingAnimation></syntaxhighlight>
|Creates a new <code>BimanualSwingAnimation</code> using the options. Returns an <code>ObjectValue<BimanualSwingAnimation></code> of the newly created <code>BimanualSwingAnimation</code>. The default values are in order here: <code>0.6662, 1.0, 'arm_left', 'arm_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.bimanual_swing()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">sine_wing_flap(amplitude: Double?, period: Double?, verticalShift: Double?, axis: String?, wingLeft: String?, wingRight: String?): ObjectValue<WingFlapIdleAnimation></syntaxhighlight>
|Creates a new <code>WingFlapIdleAnimation</code> using the options. Returns an <code>ObjectValue<WingFlapIdleAnimation></code> of the newly created <code>WingFlapIdleAnimation</code>. The default values are in order here: <code>0.9, 0.9, 0.0, 'y', 'wing_left', 'wing_right'</code>. The <code>axis</code> can either be 'x', 'y', or 'z'.
|<syntaxhighlight lang="kotlin">v.model.sine_wing_flap()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_quirk(animationGroup: String, animationNames: MoValue, minSeconds: Double?, maxSeconds: Double?, loopTimes: Int?): ObjectValue<SimpleQuirk></syntaxhighlight>
|Creates a new <code>SimpleQuirk</code> using the <code>animationGroup</code>, <code>animationNames</code> and the other options. <code>animationNames</code> can either be an <code>ArrayStruct<String></code> or a single String. Returns an <code>ObjectValue<SimpleQuirk></code> of the newly created <code>SimpleQuirk</code>. The default values are in order here: <code>8.0, 30.0, 1</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">primary_animation(activeAnimation: ObjectValue<ActiveAnimation>, options: MoValue...): MoValue</syntaxhighlight>
|Creates a new <code>PrimaryAnimation</code> using the <code>activeAnimation</code>. The <code>options</code> can either be <code>ExcludedLabels</code>, a <code>WaveFunction</code> (only the last one is used), or a String that represents a label to exclude. Returns an <code>ObjectValue<PrimaryAnimation></code> of the newly created <code>PrimaryAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">punch(headName: String?, bodyName: String?, leftArmName: String?, rightArmName: String?, swingRight? Boolean): ObjectValue<PunchAnimation></syntaxhighlight>
|Creates a new <code>PunchAnimation</code> using the options. Returns an <code>ObjectValue<PunchAnimation></code> of the newly created <code>PunchAnimation</code>. The default values are in order here: <code>'head', 'body', 'arm_left', 'arm_right', true</code>.
|<syntaxhighlight lang="kotlin">v.model.punch()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_primary_quirk(animationGroup: String, animationNames: MoValue, minSeconds: Double?, maxSeconds: Double?, loopTimes: Int?, options: MoValue...): ObjectValue<SimpleQuirk></syntaxhighlight>
|Creates a new <code>SimpleQuirk</code> using the <code>animationGroup</code>, <code>animationNames</code> and the other options. <code>animationNames</code> can either be an <code>ArrayStruct<String></code> or a single String. Returns an <code>ObjectValue<SimpleQuirk></code> of the newly created <code>SimpleQuirk</code>. The default values are in order here: <code>8.0, 30.0, 1</code>. The <code>options</code> can either be a <code>WaveFunction</code> (only the last one is used) or a String that represents a label to exclude.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|}

Molang Animation Functions

2025-04-19T23:08:02Z

JPAKx4: Fixed formatting

Type is <code>QueryStruct<PoseableModel></code>.
{| class="wikitable fixed-header sortable"
|<syntaxhighlight lang="kotlin">exclude_labels(): ObjectValue<ExcludedLabels></syntaxhighlight>
|Returns an <code>ObjectValue<ExcludedLabels></code> from a <code>PoseableModel</code>.
|<syntaxhighlight lang="kotlin">v.model.exclude_labels()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_primary(group: String, animation: String, options: MoValue...): ObjectValue<PrimaryAnimation></syntaxhighlight>
|Creates a new <code>PrimaryAnimation</code> using the <code>group</code> and <code>animation</code>. The <code>options</code> can either be <code>ExcludedLabels</code>, a <code>WaveFunction</code> (only the last one is used), or a String that represents a label to exclude. Returns an <code>ObjectValue<PrimaryAnimation></code> of the newly created <code>PrimaryAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_stateful(group: String, animation: String, enduresPrimary: IDK WHAT THIS IS): ObjectValue<BedrockActiveAnimation></syntaxhighlight>
|Creates a new <code>BedrockActiveAnimation</code> using the <code>group</code> and <code>animation</code>. IDK WHAT EDURESPRIMARY IS. Returns an <code>ObjectValue<BedrockActiveAnimation></code> of the newly created <code>BedrockActiveAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock(group: String, animation: String): ObjectValue<BedrockPoseAnimation></syntaxhighlight>
|Creates a new <nowiki><code>BedrockPoseAnimation</code></nowiki> using the <nowiki><code>group</code></nowiki> and <nowiki><code>animation</code></nowiki>. Returns an <nowiki><code>ObjectValue<BedrockActiveAnimation></code></nowiki> of the newly created <nowiki><code>BedrockActiveAnimation</code></nowiki>.
|<syntaxhighlight lang="kotlin">
I don't know what is an example
</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">look(boneName: String, pitchMultiplier: Double?, yawMulitplier: Double?, maxPitch: Double?, minPitch: Double?, maxYaw, Double?, minYaw: Double?): ObjectValue<SingleBoneLookAnimation></syntaxhighlight>
|Creates a new <code>SingleBoneLookAnimation</code> using the <code>boneName</code> and other options. Returns an <code>ObjectValue<SingleBoneLookAnimation></code> of the newly created <code>SingleBoneLookAnimation</code>. The default values are in order here: <code>1.0, 1.0, 70.0, -45.0, 45.0, -45.0</code>.
|<syntaxhighlight lang="kotlin">v.model.look('head')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">quadruped_walk(periodMultiplier: Double?, amplitudeMultiplier: Double? leftFrontLeftName: String?, leftFrontRightName: String?, leftBackLeftName: String?. leftBackRightName: String?): ObjectValue<QuadrupedWalkAnimation></syntaxhighlight>
|Creates a new <code>QuadrupedWalkAnimation</code> using the options. Returns an <code>ObjectValue<QuadrupedWalkAnimation></code> of the newly created <code>QuadrupedWalkAnimation</code>. The default values are in order here: <code>0.6662, 1.4, 'leg_front_left', leg_front_right', 'leg_back_left', 'leg_back_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.quadruped_walk()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">biped_walk(periodMultiplier: Double?, amplitudeMultiplier: Double? leftLegName?: String, rightLegName: String?): ObjectValue<BipedWalkAnimation></syntaxhighlight>
|Creates a new <code>BipedWalkAnimation</code> using the options. Returns an <code>ObjectValue<BipedWalkAnimation></code> of the newly created <code>BipedWalkAnimation</code>. The default values are in order here: <code>0.6662, 1.4, 'leg_left', 'leg_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.biped_walk()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bimanual_swing(periodMultiplier: Double?, amplitudeMultiplier: Double? leftArmName: String?, rightArmName String?): ObjectValue<BimanualSwingAnimation></syntaxhighlight>
|Creates a new <code>BimanualSwingAnimation</code> using the options. Returns an <code>ObjectValue<BimanualSwingAnimation></code> of the newly created <code>BimanualSwingAnimation</code>. The default values are in order here: <code>0.6662, 1.0, 'arm_left', 'arm_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.bimanual_swing()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">sine_wing_flap(amplitude: Double?, period: Double?, verticalShift: Double?, axis: String?, wingLeft: String?, wingRight: String?): ObjectValue<WingFlapIdleAnimation></syntaxhighlight>
|Creates a new <code>WingFlapIdleAnimation</code> using the options. Returns an <code>ObjectValue<WingFlapIdleAnimation></code> of the newly created <code>WingFlapIdleAnimation</code>. The default values are in order here: <code>0.9, 0.9, 0.0, 'y', 'wing_left', 'wing_right'</code>. The <code>axis</code> can either be 'x', 'y', or 'z'.
|<syntaxhighlight lang="kotlin">v.model.sine_wing_flap()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_quirk(animationGroup: String, animationNames: MoValue, minSeconds: Double?, maxSeconds: Double?, loopTimes: Int?): ObjectValue<SimpleQuirk></syntaxhighlight>
|Creates a new <code>SimpleQuirk</code> using the <code>animationGroup</code>, <code>animationNames</code> and the other options. <code>animationNames</code> can either be an <code>ArrayStruct<String></code> or a single String. Returns an <code>ObjectValue<SimpleQuirk></code> of the newly created <code>SimpleQuirk</code>. The default values are in order here: <code>8.0, 30.0, 1</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">primary_animation(activeAnimation: ObjectValue<ActiveAnimation>, options: MoValue...): MoValue</syntaxhighlight>
|Creates a new <code>PrimaryAnimation</code> using the <code>activeAnimation</code>. The <code>options</code> can either be <code>ExcludedLabels</code>, a <code>WaveFunction</code> (only the last one is used), or a String that represents a label to exclude. Returns an <code>ObjectValue<PrimaryAnimation></code> of the newly created <code>PrimaryAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">punch(headName: String?, bodyName: String?, leftArmName: String?, rightArmName: String?, swingRight? Boolean): ObjectValue<PunchAnimation></syntaxhighlight>
|Creates a new <code>PunchAnimation</code> using the options. Returns an <code>ObjectValue<PunchAnimation></code> of the newly created <code>PunchAnimation</code>. The default values are in order here: <code>'head', 'body', 'arm_left', 'arm_right', true</code>.
|<syntaxhighlight lang="kotlin">v.model.punch()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_primary_quirk(animationGroup: String, animationNames: MoValue, minSeconds: Double?, maxSeconds: Double?, loopTimes: Int?, options: MoValue...): ObjectValue<SimpleQuirk></syntaxhighlight>
|Creates a new <code>SimpleQuirk</code> using the <code>animationGroup</code>, <code>animationNames</code> and the other options. <code>animationNames</code> can either be an <code>ArrayStruct<String></code> or a single String. Returns an <code>ObjectValue<SimpleQuirk></code> of the newly created <code>SimpleQuirk</code>. The default values are in order here: <code>8.0, 30.0, 1</code>. The <code>options</code> can either be a <code>WaveFunction</code> (only the last one is used) or a String that represents a label to exclude.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|}

Molang Animation Functions

2025-04-19T23:03:02Z

JPAKx4: Added Molang Animation Functions

Type is <code>QueryStruct<PoseableModel></code>.
{| class="wikitable fixed-header sortable"
|<syntaxhighlight lang="kotlin">exclude_labels(): ObjectValue<ExcludedLabels></syntaxhighlight>
|Returns an <code>ObjectValue<ExcludedLabels></code> from a <code>PoseableModel</code>.
|<syntaxhighlight lang="kotlin">v.model.exclude_labels()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_primary(group: String, animation: String, options: MoValue...): ObjectValue<PrimaryAnimation></syntaxhighlight>
|Creates a new <code>PrimaryAnimation</code> using the <code>group</code> and <code>animation</code>. The <code>options</code> can either be <code>ExcludedLabels</code>, a <code>WaveFunction</code> (only the last one is used), or a String that represents a label to exclude. Returns an <code>ObjectValue<PrimaryAnimation></code> of the newly created <code>PrimaryAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_stateful(group: String, animation: String, enduresPrimary: IDK WHAT THIS IS): ObjectValue<BedrockActiveAnimation></syntaxhighlight>
|Creates a new <code>BedrockActiveAnimation</code> using the <code>group</code> and <code>animation</code>. IDK WHAT EDURESPRIMARY IS. Returns an <code>ObjectValue<BedrockActiveAnimation></code> of the newly created <code>BedrockActiveAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock(group: String, animation: String): ObjectValue<BedrockPoseAnimation>
|Creates a new <code>BedrockPoseAnimation</code> using the <code>group</code> and <code>animation</code>. Returns an <code>ObjectValue<BedrockActiveAnimation></code> of the newly created <code>BedrockActiveAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">look(boneName: String, pitchMultiplier: Double?, yawMulitplier: Double?, maxPitch: Double?, minPitch: Double?, maxYaw, Double?, minYaw: Double?): ObjectValue<SingleBoneLookAnimation></syntaxhighlight>
|Creates a new <code>SingleBoneLookAnimation</code> using the <code>boneName</code> and other options. Returns an <code>ObjectValue<SingleBoneLookAnimation></code> of the newly created <code>SingleBoneLookAnimation<code>. The default values are in order here: <code>1.0, 1.0, 70.0, -45.0, 45.0, -45.0</code>.
|<syntaxhighlight lang="kotlin">v.model.look('head')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">quadruped_walk(periodMultiplier: Double?, amplitudeMultiplier: Double? leftFrontLeftName: String?, leftFrontRightName: String?, leftBackLeftName: String?. leftBackRightName: String?): ObjectValue<QuadrupedWalkAnimation></syntaxhighlight>
|Creates a new <code>QuadrupedWalkAnimation</code> using the options. Returns an <code>ObjectValue<QuadrupedWalkAnimation></code> of the newly created <code>QuadrupedWalkAnimation<code>. The default values are in order here: <code>0.6662, 1.4, 'leg_front_left', leg_front_right', 'leg_back_left', 'leg_back_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.quadruped_walk()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">biped_walk(periodMultiplier: Double?, amplitudeMultiplier: Double? leftLegName?: String, rightLegName: String?): ObjectValue<BipedWalkAnimation></syntaxhighlight>
|Creates a new <code>BipedWalkAnimation</code> using the options. Returns an <code>ObjectValue<BipedWalkAnimation></code> of the newly created <code>BipedWalkAnimation<code>. The default values are in order here: <code>0.6662, 1.4, 'leg_left', 'leg_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.biped_walk()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bimanual_swing(periodMultiplier: Double?, amplitudeMultiplier: Double? leftArmName: String?, rightArmName String?): ObjectValue<BimanualSwingAnimation></syntaxhighlight>
|Creates a new <code>BimanualSwingAnimation</code> using the options. Returns an <code>ObjectValue<BimanualSwingAnimation></code> of the newly created <code>BimanualSwingAnimation<code>. The default values are in order here: <code>0.6662, 1.0, 'arm_left', 'arm_right'</code>.
|<syntaxhighlight lang="kotlin">v.model.bimanual_swing()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">sine_wing_flap(amplitude: Double?, period: Double?, verticalShift: Double?, axis: String?, wingLeft: String?, wingRight: String?): ObjectValue<WingFlapIdleAnimation></syntaxhighlight>
|Creates a new <code>WingFlapIdleAnimation</code> using the options. Returns an <code>ObjectValue<WingFlapIdleAnimation></code> of the newly created <code>WingFlapIdleAnimation<code>. The default values are in order here: <code>0.9, 0.9, 0.0, 'y', 'wing_left', 'wing_right'</code>. The <code>axis</code> can either be 'x', 'y', or 'z'.
|<syntaxhighlight lang="kotlin">v.model.sine_wing_flap()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_quirk(animationGroup: String, animationNames: MoValue, minSeconds: Double?, maxSeconds: Double?, loopTimes: Int?): ObjectValue<SimpleQuirk></syntaxhighlight>
|Creates a new <code>SimpleQuirk</code> using the <code>animationGroup</code>, <code>animationNames</code> and the other options. <code>animationNames</code> can either be an <code>ArrayStruct<String></code> or a single String. Returns an <code>ObjectValue<SimpleQuirk></code> of the newly created <code>SimpleQuirk<code>. The default values are in order here: <code>8.0, 30.0, 1</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">primary_animation(activeAnimation: ObjectValue<ActiveAnimation>, options: MoValue...): MoValue</syntaxhighlight>
|Creates a new <code>PrimaryAnimation</code> using the <code>activeAnimation</code>. The <code>options</code> can either be <code>ExcludedLabels</code>, a <code>WaveFunction</code> (only the last one is used), or a String that represents a label to exclude. Returns an <code>ObjectValue<PrimaryAnimation></code> of the newly created <code>PrimaryAnimation</code>.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">punch(headName: String?, bodyName: String?, leftArmName: String?, rightArmName: String?, swingRight? Boolean): ObjectValue<PunchAnimation></syntaxhighlight>
|Creates a new <code>PunchAnimation</code> using the options. Returns an <code>ObjectValue<PunchAnimation></code> of the newly created <code>PunchAnimation<code>. The default values are in order here: <code>'head', 'body', 'arm_left', 'arm_right', true</code>.
|<syntaxhighlight lang="kotlin">v.model.punch()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bedrock_primary_quirk(animationGroup: String, animationNames: MoValue, minSeconds: Double?, maxSeconds: Double?, loopTimes: Int?, options: MoValue...): ObjectValue<SimpleQuirk></syntaxhighlight>
|Creates a new <code>SimpleQuirk</code> using the <code>animationGroup</code>, <code>animationNames</code> and the other options. <code>animationNames</code> can either be an <code>ArrayStruct<String></code> or a single String. Returns an <code>ObjectValue<SimpleQuirk></code> of the newly created <code>SimpleQuirk<code>. The default values are in order here: <code>8.0, 30.0, 1</code>. The <code>options</code> can either be a <code>WaveFunction</code> (only the last one is used) or a String that represents a label to exclude.
|<syntaxhighlight lang="kotlin">I don't know what is an example</syntaxhighlight>
|}

Molang Client General Functions

2025-04-19T23:02:00Z

JPAKx4: Added Client General Molang Functions

{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">sound(soundId: ResourceLocation, _: any, pitch: Double?) 3 params but only two used?</syntaxhighlight>
|Plays a sound with <code>soundId</code> identifier. <code>pitch</code> is <code>1.0</code> by defaut.
|<syntaxhighlight lang="kotlin">q.sound('minecraft:block.chest.close')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_time(min: Int, max: Int): Double</syntaxhighlight>
|Returns <code>1.0</code> if time in ticks is in between <code>min</code> and <code>max</code> (inclusive).
|<syntaxhighlight lang="kotlin">q.is_time(0, 24000)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">say(message: String)</syntaxhighlight>
|Puts the <code>message</code> in the chat.
|<syntaxhighlight lang="kotlin">q.say('Hello World!')</syntaxhighlight>
|}

Molang Pokédex Functions

2025-04-19T23:00:59Z

JPAKx4: Fix Formatting

Type is <code>ObjectValue<AbstractPokedexManager></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Must Be <code>PokedexManager</code>
|-
|<syntaxhighlight lang="kotlin">get_species_record(species: ResourceLocation): QueryStruct</syntaxhighlight>
|Returns a <code>QueryStruct<SpeciesDexRecord></code> with useful functions for acessing and modifiing records. If the <code>ResourceLocation</code> is invalid or the record does not exist then the function returns an empty <code>QueryStruct</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.get_species_record('pikachu')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">has_seen(species: ResourceLocation, form: String?): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon of <code>species</code> and optionally <code>form</code> been encountered or higher, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.has_seen('pikachu')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">has_caught(species: ResourceLocation, form: String?): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon of <code>species</code> and optionally <code>form</code> been caught, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.has_caught('cobblemon:pikachu', 'alolan')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">caught_count(): Double</syntaxhighlight>
|Returns the number of caught Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokedex.caught_count()</syntaxhighlight>
|
|-

|<syntaxhighlight lang="kotlin">seen_count(): Double</syntaxhighlight>
|
Returns the number of seen Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokedex.seen_count()</syntaxhighlight>
|
|-

|<syntaxhighlight lang="kotlin">caught_percent(): Double</syntaxhighlight>
|
Returns the percent of Pokémon caught as a Double.
|<syntaxhighlight lang="kotlin">v.pokedex.caught_percent()</syntaxhighlight>
|-

|<syntaxhighlight lang="kotlin">seen_percent(): Double</syntaxhighlight>
|
Returns the percent of Pokémon seen as a Double.
|<syntaxhighlight lang="kotlin">v.pokedex.seen_percent()</syntaxhighlight>
|
|-

|<syntaxhighlight lang="kotlin">player_id(): String</syntaxhighlight>
|Returns the Player's UUID that belongs to the Pokédex.
|<syntaxhighlight lang="kotlin">v.pokedex.player_id()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">see(pokemon: ObjectValue<Pokemon>): Double</syntaxhighlight>
|Updates the Pokédex with a new encountered record of the <code>Pokemon</code>. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.see(v.pokemon)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">catch(Pokemon: ObjectValue<Pokemon>): Double</syntaxhighlight>
|Updates the Pokédex with a new catch record of the <code>Pokemon</code>. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.catch(v.pokemon)</syntaxhighlight>
|Yes
|}

Molang Species Functions

2025-04-19T22:54:02Z

JPAKx4: Added Molang Species Functions

Type is <code>ObjectValue<Species></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">identifier(): ResourceIdentifier</syntaxhighlight>
|Returns the species as a <code>ResourceIdentifier</code>.
|<syntaxhighlight lang="kotlin">v.species.identifier()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">name(): String</syntaxhighlight>
|Returns the species name as a String.
|<syntaxhighlight lang="kotlin">v.species.name()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">primary_type(): String</syntaxhighlight>
|Returns the primary type as a String.
|<syntaxhighlight lang="kotlin">v.species.primary_type()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">secondary_type(): String</syntaxhighlight>
|Returns the secondary type or 'null' as a String.
|<syntaxhighlight lang="kotlin">v.species.secondary()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">experience_group(): String</syntaxhighlight>
|Returns the experience group as a String.
|<syntaxhighlight lang="kotlin">v.species.experience_group()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">height(): Double</syntaxhighlight>
|Returns the height as a Double.
|<syntaxhighlight lang="kotlin">v.species.height()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">weigth(): Double</syntaxhighlight>
|Returns the weight as a Double.
|<syntaxhighlight lang="kotlin">v.species.weight()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">base_scale(): Double</syntaxhighlight>
|Returns the base scale as a Double.
|<syntaxhighlight lang="kotlin">v.species.base_scale()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">hitbox_width(): Double</syntaxhighlight>
|Returns the hitbox width as a Double.
|<syntaxhighlight lang="kotlin">v.species.hitbox_width()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">hitbox_height(): Double</syntaxhighlight>
|Returns the hitbox height as a Double.
|<syntaxhighlight lang="kotlin">v.species.hitbox_height()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">hitbox_fixed(): Double</syntaxhighlight>
|Returns the hitbox fixed as a Double.
|<syntaxhighlight lang="kotlin">v.species.hitbox_fixed()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">catch_rate(): Double</syntaxhighlight>
|Returns the catch rate as a Double.
|<syntaxhighlight lang="kotlin">v.species.catch_rate()</syntaxhighlight>
|}

Molang Pokédex Functions

2025-04-19T22:52:25Z

JPAKx4: Added Pokedex Molang Functions

Type is <code>ObjectValue<AbstractPokedexManager></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Must Be <code>PokedexManager</code>
|-
|<syntaxhighlight lang="kotlin">get_species_record(species: ResourceLocation): QueryStruct</syntaxhighlight>
|Returns a <code>QueryStruct<SpeciesDexRecord></code> with useful functions for acessing and modifiing records. If the <code>ResourceLocation</code> is invalid or the record does not exist then the function returns an empty <code>QueryStruct</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.get_species_record('pikachu')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">has_seen(species: ResourceLocation, form: String?): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon of <code>species</code> and optionally <code>form</code> been encountered or higher, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.has_seen('pikachu')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">has_caught(species: ResourceLocation, form: String?): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon of <code>species</code> and optionally <code>form</code> been caught, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.has_caught('cobblemon:pikachu', 'alolan')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">caught_count(): Double</syntaxhighlight>
|Returns the number of caught Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokedex.caught_count()</syntaxhighlight>
|
|-
<syntaxhighlight lang="kotlin">|seen_count(): Double</syntaxhighlight>
|Returns the number of seen Pokémon as a Double.
<syntaxhighlight lang="kotlin">|v.pokedex.seen_count()</syntaxhighlight>
|
|-
<syntaxhighlight lang="kotlin">|caught_percent(): Double</syntaxhighlight>
|Returns the percent of Pokémon caught as a Double.
<syntaxhighlight lang="kotlin">|v.pokedex.caught_percent()</syntaxhighlight>
|
|-
<syntaxhighlight lang="kotlin">|seen_percent(): Double</syntaxhighlight>
|Returns the percent of Pokémon seen as a Double.
<syntaxhighlight lang="kotlin">|v.pokedex.seen_percent()</syntaxhighlight>
|
|-
<syntaxhighlight lang="kotlin">|player_id(): String</syntaxhighlight>
|Returns the Player's UUID that belongs to the Pokédex.
<syntaxhighlight lang="kotlin">|v.pokedex.player_id()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">see(pokemon: ObjectValue<Pokemon>): Double</syntaxhighlight>
|Updates the Pokédex with a new encountered record of the <code>Pokemon</code>. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.see(v.pokemon)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">catch(Pokemon: ObjectValue<Pokemon>): Double</syntaxhighlight>
|Updates the Pokédex with a new catch record of the <code>Pokemon</code>. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokedex.catch(v.pokemon)</syntaxhighlight>
|Yes
|}

Molang Server Functions

2025-04-19T22:49:43Z

JPAKx4: Added Molang Server Functions

Type is <code>ObjectValue<MinecraftServer></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">get_world(dimension: ResourceLocation): MoValue</syntaxhighlight>
|If <code>dimension</code> is valid then returns an <code>ObjectValue<World></code>, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.server.get_world('minecraft:nether')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">broadcast(message: String, bypassHiddenChat: Boolean?): Double</syntaxhighlight>
|Sends the <code>message</code> to all players. <code>bypassHiddenChat</code> is <code>false</code> by default.
|<syntaxhighlight lang="kotlin">v.server.broadcast('Hello World!')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_player_by_uuid(uuid: String): MoValue</syntaxhighlight>
|If <code>uuid</code> is a valid UUID then returns an <code>ObjectValue<Player></code>, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.server.get_player_by_uuid(v.player_uuid)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_player_by_username(name: String): MoValue</syntaxhighlight>
|If <code>name</code> is a valid name then returns an <code>ObjectValue<Player></code>, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.server.get_player_by_username(v.player_name)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">data(): VariableStruct</syntaxhighlight>
|Returns the <code>VariableStruct</code> representing <code>MoLangDataStoreFactory</code>.
|<syntaxhighlight lang="kotlin">v.server.data()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">save_data(): Double</syntaxhighlight>
|Saves the <code>MoLangDataStoreFactory</code> and returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.server.save_data()</syntaxhighlight>
|}

Molang SpawningContext Functions

2025-04-19T22:49:09Z

JPAKx4: Added Molang SpawningContext Functions

Type is <code>ObjectValue<SpawningContext></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">biome(): ObjectValue<Biome></syntaxhighlight>
|Returns an <code>ObjectValue<Biome></code> of the biome the SpawningContext is in.
|<syntaxhighlight lang="kotlin">v.spawning_context.biome()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">world(): ObjectValue<World></syntaxhighlight>
|Returns an <code>ObjectValue<World></code> of the world the SpawningContext is in.
|<syntaxhighlight lang="kotlin">v.spawning_context.world()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">light(): Double</syntaxhighlight>
|Returns the light value of the SpawningContext.
|<syntaxhighlight lang="kotlin">v.spawning_context.light()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">x(): Double</syntaxhighlight>
|Returns the x value as a Double.
|<syntaxhighlight lang="kotlin">v.spawning_context.x()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">y(): Double</syntaxhighlight>
|Returns the y value as a Double.
|<syntaxhighlight lang="kotlin">v.spawning_context.y()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">z(): Double</syntaxhighlight>
|Returns the z value as a Double.
|<syntaxhighlight lang="kotlin">v.spawning_context.z()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">moon_phase(): Double</syntaxhighlight>
|Returns the moon phase as a Double
|<syntaxhighlight lang="kotlin">v.spawning_context.moon_phase()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">can_see_sky(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the SpawningContext can see the sky, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.spawning_context.can_see_sky()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">bucket(): String</syntaxhighlight>
|Returns the bucket as a String.
|<syntaxhighlight lang="kotlin">v.spawning_context.bucket()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">player(): MoValue</syntaxhighlight>
|Returns an <code>ObjectValue<Player></code> if the spawning was caused by a player, otherwise returns <code>0.0</code>
|<syntaxhighlight lang="kotlin">v.spawning_context.player()</syntaxhighlight>
|}

Molang PC Functions

2025-04-19T22:47:09Z

JPAKx4: Added PC Molang functions

Can also use [[Molang PokémonStore Functions|PokémonStore functions]]. Type is <code>ObjectValue<PCStore></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">get_pokemon(box: Int, slot: Int): MoValue</syntaxhighlight>
|Returns an <code>ObjectValue<Pokemon></code> of the pokemon at the supplied <code>box</code> and <code>slot</code>. Returns <code>0.0</code> if there is no Pokémon there.
|<syntaxhighlight lang="kotlin">v.pc.get_pokemon(0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">resize(newSize: Int, lockNewSize: Boolean?): Double</syntaxhighlight>
|Resizes the PC with the supplied <code>newSize</code>. <code>lockNewSize</code> is <code>false</code> by default. Returns <code>1.0</code>.</syntaxhighlight>
|<syntaxhighlight lang="kotlin">v.pc.resize(25)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_box_count(): Double</syntaxhighlight>
|Returns the number of boxes as a Double.
|<syntaxhighlight lang="kotlin">v.pc.get_box_count()</syntaxhighlight>
|}

Molang Party Functions

2025-04-19T22:46:19Z

JPAKx4: Added Molang Party Functions

Can also use [[Molang PokémonStore Functions|PokémonStore functions]]. Type is <code>ObjectValue<PartyStore></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">get_pokemon(index: Int): MoValue</syntaxhighlight>
|Returns an <code>ObjectValue<Pokemon></code> at the <code>index</code> of the party. Returns <code>0.0</code> if there is no Pokémon at the supplied <code>index</code>.
|<syntaxhighlight lang="kotlin">v.party.get_pokemon(0)</syntaxhighlight>
|}

Molang PokémonEntity Functions

2025-04-19T22:44:01Z

JPAKx4: Switch to common molang syntax.

Can also use [[Molang Entity Functions|entity]] and [[Molang Pokémon Functions|pokémon]] functions. Type is <code>ObjectValue<PokemonEntity></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">in_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon_entity.in_battle()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_moving(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is moving otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon_entity.is_moving()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_flying(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is in flying, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon_entity.is_flying()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">has_aspect(aspect: String): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon has the <code>aspect</code>, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon_entity.has_aspect('alolan')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_pokemon(): Double</syntaxhighlight>
|Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon_entity.is_pokemon()</syntaxhighlight>
|}

Molang PokémonEntity Functions

2025-04-19T22:41:59Z

JPAKx4: Added Molang PokemonEntity Functions

Can also use [[Molang Entity Functions|entity]] and [[Molang Pokémon Functions|pokémon]] functions. Type is <code>ObjectValue<PokemonEntity></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">in_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemonEntity.in_battle()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_moving(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is moving otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemonEntity.is_moving()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_flying(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is in flying, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemonEntity.is_flying()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">has_aspect(aspect: String): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon has the <code>aspect</code>, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemonEntity.has_aspect('alolan')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_pokemon(): Double</syntaxhighlight>
|Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemonEntity.is_pokemon()</syntaxhighlight>
|}

Molang PokémonStore Functions

2025-04-19T22:41:43Z

JPAKx4: Added Molang PokemonStore Functions

Type is <code>ObjectValue<PokemonStore<*>></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">add(pokemon: ObjectValue<Pokemon>): Double</syntaxhighlight>
|Adds Pokémon to the first available spot. Returns <code>1.0</code> if there was space, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.store.add(v.pokemon)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">add_by_properties(properties: String): Double</syntaxhighlight>
|If the type of the store is <code>PlayerPartyStore</code> then create a Pokémon with the listed <code>properties</code> and add it to the store. Returns <code>1.0</code> if there was space, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.store.add_by_properties('species=cobblemon:pikachu gender=male')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">find_by_properties(properties: String): MoValue</syntaxhighlight>
|Finds the first Pokémon with the listed <code>properties</code> in the store and returns a <code>ObjectValue<Pokemon></code> Returns <code>0.0</code> if no pokemon found.
|<syntaxhighlight lang="kotlin">v.store.find_by_properties('species=cobblemon:pikachu gender=male')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">find_all_by_properties(properties: String): MoValue</syntaxhighlight>
|Returns an <code>ArrayStruct<ObjectValue<Pokemon>></code> of all Pokémon with the listed <code>properties</code> in the store.
|<syntaxhighlight lang="kotlin">v.store.find_all_by_properties('species=cobblemon:pikachu gender=male')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">find_by_id(id: String): MoValue</syntaxhighlight>
|Returns an <code>ObjectValue<Pokemon></code> that matches the UUID <code>id</code> of the Pokémon. Returns <code>0.0</code> if no Pokémon is found.
|<syntaxhighlight lang="kotlin">v.store.find_by_id(v.pokemon.id())</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">remove_by_id(id: String): Double</syntaxhighlight>
|Removes a Pokémon that matches the UUID <code>id</code>. Returns <code>1.0</code> if removed, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.store.remove_by_id(v.pokemon.id())</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">average_level(): Double</syntaxhighlight>
|Returns the average level of all Pokémon in the store. Returns <code>0.0</code> if there is no Pokémon.
|<syntaxhighlight lang="kotlin">v.store.average_level()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">count(): Double</syntaxhighlight>
|Returns the number of Pokémon in a store.
|<syntaxhighlight lang="kotlin">v.store.count()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">count_by_properties(properties: String): Double</syntaxhighlight>
|Returns the count of Pokémon that match the listed <code>properties</code>.
|<syntaxhighlight lang="kotlin">v.store.count_by_properties('gender=male')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">highest_level(): Double</syntaxhighlight>
|Returns the highest level of all Pokémon in a store as a Double.
|<syntaxhighlight lang="kotlin">v.store.highest_level()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">lowest_level(): Double</syntaxhighlight>
|Returns the lowest level of all Pokémon in a store as a Double.
|<syntaxhighlight lang="kotlin">v.store.lowest_level()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">heal(): Double</syntaxhighlight>
|Heals all Pokémon in a store. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.store.heal()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">healing_remainder_percent(): Double</syntaxhighlight>
|Returns the cumulative percentage of health missing as a Double.</syntaxhighlight>
|<syntaxhighlight lang="kotlin">v.store.healing_remainder_percent()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">has_usable_pokemon(): Double</syntaxhighlight>
|Returns <code>1.0</code> if any Pokémon is not fainted, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.store.has_usable_pokemon()</syntaxhighlight>
|}

Molang Pokémon Functions

2025-04-19T22:38:48Z

JPAKx4: Added Molang Pokemon Functions

Type is <code>ObjectValue<Pokemon></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">id(): String</syntaxhighlight>
|Returns the UUID of the Pokémon as a String.
|<syntaxhighlight lang="kotlin">v.pokemon.id()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">level(): Double</syntaxhighlight>
|Returns the level of the Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokemon.level()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">max_hp(): Double</syntaxhighlight>
|Returns the max hp of the Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokemon.hp()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">current_hp(): Double</syntaxhighlight>
|Returns the current hp of the Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokemon.current_hp()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">friendship(): Double</syntaxhighlight>
|Returns the friendship of the Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokemon.friendship()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">evs(): QueryStruct</syntaxhighlight>
|Returns all evs of the Pokémon as a <code>QueryStruct</code>.
|<syntaxhighlight lang="kotlin">v.pokemon.evs()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">ivs(): QueryStuct</syntaxhighlight>
|Returns all ivs of the Pokémon as a <code>QueryStruct</code>.
|<syntaxhighlight lang="kotlin">v.pokemon.ivs()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_wild(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is wild, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon.is_wild()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_shiny(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon is shiny, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon.is_shiny()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">species(): ObjectValue<Species></syntaxhighlight>
|Returns an ObjectValue<Species> of the Pokémon's species.
|<syntaxhighlight lang="kotlin">v.pokemon.species()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">form(): String</syntaxhighlight>
|Returns the form as a String.
|<syntaxhighlight lang="kotlin">v.pokemon.form()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">weight: Double</syntaxhighlight>
|Returns the weight of the Pokémon as a Double.
|<syntaxhighlight lang="kotlin">v.pokemon.weight()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">matches(properties: String): Double</syntaxhighlight>
|Returns <code>1.0</code> if the Pokémon matches the <code>properties</code> String, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon.matches('gender=male')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">apply(properties: String): Double</syntaxhighlight>
|Applies the <code>properties</code> to the Pokémon. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">v.pokemon.apply('gender=male')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">owner(): MoValue</syntaxhighlight>
|Returns the Pokémon's owner as a <code>ObjectValue<Player></code> or <code>0.0</code> if there is no owner.
|<syntaxhighlight lang="kotlin">v.pokemon.owner()</syntaxhighlight>
|}

Molang BattleActor Functions

2025-04-19T22:37:31Z

JPAKx4: Add Molang BattleActor Functions

Type is <code>ObjectValue<BattleActor></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Must be called on
|-
|<syntaxhighlight lang="kotlin">is_npc(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the actor is a NPC, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.actor.is_npc()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_player(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the actor is a Player, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.actor.is_player()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">is_wild(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the actor is a wild Pokémon, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.actor.is_wild()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">npc(): ObjectValue<NPCBattleActor></syntaxhighlight>
|Returns a struct of <code>ObjectValue<NPCBattleActor></code>.
|<syntaxhighlight lang="kotlin">v.actor.npc()</syntaxhighlight>
|NPCBattleActor
|-
|<syntaxhighlight lang="kotlin">player(): ObjectValue<PlayerBattleActor></syntaxhighlight>
|Returns a struct of <code>ObjectValue<PlayerBattleActor></code>.
|<syntaxhighlight lang="kotlin">v.actor.player()</syntaxhighlight>
|PlayerBattleActor
|}

Molang Battle Functions

2025-04-19T22:18:04Z

JPAKx4: Add Molang Battle Functions

Type is <code>ObjectValue<PokemonBattle></code>.
{| class="wikitable fixed-header sortable"
|<syntaxhighlight lang="kotlin">battle_id(): String</syntaxhighlight>
|Returns the ID of the battle as a String.
|<syntaxhighlight lang="kotlin">q.battle.battle_id()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_pvn(): Double</syntaxhighlight>
|Returns <code>1.0</code> if battle is Player vs. NPC, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.battle.is_pvn()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_pvp(): Double</syntaxhighlight>
|Returns <code>1.0</code> if battle is Player vs. Player, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.battle.is_pvp()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_pvw(): Double</syntaxhighlight>
|Returns <code>1.0</code> if battle is Player vs. a wild Pokémon, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.battle.is_pve()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">battle_type(): String</syntaxhighlight>
|Returns the battle format as a String.
|<syntaxhighlight lang="kotlin">q.battle.battle_type()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">environment(): CHECK TYPE</syntaxhighlight>
|Returns the environment.
|<syntaxhighlight lang="kotlin">q.battle.environment()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_actor(uuid: String): MoValue</syntaxhighlight>
|Returns the struct of the <code>ObjectValue<BattleActor><code> if present, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.battle.get_actor(q.npc.get_id())</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">stop()</syntaxhighlight>
|Stops the battle.
|<syntaxhighlight lang="kotlin">q.battle.stop()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">actors(): ArrayValue<ObjectValue<BattleActor>></syntaxhighlight>
|Returns an <code>ArrayValue<ObjectValue<BattleActor>></code> of all actors in a battle
|<syntaxhighlight lang="kotlin">q.battle.actors()</syntaxhighlight>
|}

Molang NPC Functions

2025-04-19T22:17:55Z

JPAKx4: Add Molang NPC Functions

Can also use [[Molang Entity Functions|entity functions]]. Type is <code>ObjectValue<NPCEntity></code>.

{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">class(): String</syntaxhighlight>
|Returns the id of the NPC as a String.
|<syntaxhighlight lang="kotlin">q.npc.class()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">name(): String</syntaxhighlight>
|Returns the name of the NPC.
|<syntaxhighlight lang="kotlin">q.npc.name()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">level(): Double</syntaxhighlight>
|Returns the level of the NPC.
|<syntaxhighlight lang="kotlin">q.npc.level()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">has_aspect(aspect: String): Double</syntaxhighlight>
|Returns <code>1.0</code> if the NPC contains the <code>aspect</code>, otherwise returns <code>0.0>/code>.
|<syntaxhighlight lang="kotlin">q.npc.has_aspect('champion')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">face(isLeftSide: Boolean?): ObjectValue<ReferenceDialogueFaceProvider></syntaxhighlight>
|Returns a ObjectValue of <code>[[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/dialogue/DialogueFace.kt ReferenceDialogueFaceProvider]]</code>. <code>isLeftSide</code> is true by default.
|<syntaxhighlight lang="kotlin">q.npc.face()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">in_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> NPC is in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.npc.in_battle()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">battles(): ArrayStruct<CHECK TYPE></syntaxhighlight>
|Returns all battles currently ongoing for this NPC.
|<syntaxhighlight lang="kotlin">q.npc.battles()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">stop_battles()</syntaxhighlight>
|Stops all ongoing battles for this NPC.
|<syntaxhighlight lang="kotlin">q.npc.stop_battles()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_doing_activity(identifiers: String...): Double</syntaxhighlight>
|Returns <code>1.0</code> if the NPC is doing any of the activities listed in the parameters, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.npc.is_doing_activity('rest', 'idle')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">run_script_on_client(script: String)</syntaxhighlight>
|If run by a server a packet will be sent to all players in the same world as the NPC that tells the clients to run the <code>script</code>.
|<syntaxhighlight lang="kotlin">q.npc.run_script_on_client('cobblemon:npc_battle_cooling_down')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">run_script(identifier: String): MoValue</syntaxhighlight>
|Runs a script from an <code>identifier</code>. Returns the result of the script or <code>0.0</code> if it fails.
|<syntaxhighlight lang="kotlin">q.npc.run_script('cobblemon:npc_battle_cooling_down')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">run_action_effect(actionIdentifier: String): Double</syntaxhighlight>
|Runs an action effect. Returns <code>1.0</code> if effect is found, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.npc.run_action_effect("cobblemon:generic_damage")</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">put_pokemon_in_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|The NPC attempts to put pokemon in a healing machine at <code>position</code>. Returns <code>1.0</code> if it succeeded, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.npc.put_pokemon_in_healer(t.pos)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">look_at_position(x: Double, y: Double, z: Double)</syntaxhighlight>
|Makes the NPC look at the position of <code>x</code>, <code>y</code>, and <code>z</code>.
|<syntaxhighlight lang="kotlin">q.npc.look_at_position(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">environment(): MoLangEnvironment</syntaxhighlight>
|Returns the NPC's environment.
|<syntaxhighlight lang="kotlin">q.npc.environment()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">party(): MoValue</syntaxhighlight>
|Returns an <code>ObjectValue<PartyStore></code> if the NPC has a party, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.npc.party()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">has_party(): Double</syntaxhighlight>
|Returns <code>1.0</code> if NPC has a party, otherwise returns <code>0.0</code>
|<syntaxhighlight lang="kotlin">q.npc.has_party()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_npc(): Double</syntaxhighlight>
|Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.npc.is_npc()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">can_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> if NPC has a party and that party has health or if the party has <code>isStatic</code> set to false. Otherwise returns <code>0.0</code>
|<syntaxhighlight lang="kotlin">q.npc.can_battle()</syntaxhighlight>
|}

Molang Player Functions

2025-04-19T22:08:52Z

JPAKx4: Add link to Entity Functions

Players can also use [[Molang Entity Functions|entity functions]]. Type is <code>ObjectValue<Player></code>.

{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Server Only
|-
|<syntaxhighlight lang="kotlin">username(): String</syntaxhighlight>
|Returns the name of a player.
|<syntaxhighlight lang="kotlin">q.player.username()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">uuid(): String</syntaxhighlight>
|Returns the UUID of a player.
|<syntaxhighlight lang="kotlin">q.player.uuid()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">main_held_item(): ObjectValue<Item></syntaxhighlight>
|Returns the Item Object in the player's main hand.
|<syntaxhighlight lang="kotlin">q.player.main_held_item()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">off_held_item(): ObjectValue<Item></syntaxhighlight>
|Returns the Item Object in the player's off hand.
|<syntaxhighlight lang="kotlin">q.player.off_held_item()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">face(isLeftSide: Boolean?): ObjectValue<PlayerDialogueFaceProvider></syntaxhighlight>
|Returns a ObjectValue of <code>[[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/dialogue/DialogueFace.kt PlayerDialogueFaceProvider]]</code>. <code>isLeftSide</code> is true by default.
|<syntaxhighlight lang="kotlin">q.player.face()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">swing_hand()</syntaxhighlight>
|Swings the player's hand.
|<syntaxhighlight lang="kotlin">q.player.swing_hand()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">food_level(): Double</syntaxhighlight>
|Returns the food level of the player.
|<syntaxhighlight lang="kotlin">q.player.food_level()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">saturation_level(): Double</syntaxhighlight>
|Returns the saturation level of the player.
|<syntaxhighlight lang="kotlin">q.player.saturation_level()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">tell(message: String, overlay: Boolean?)</syntaxhighlight>
|Displays a message in the player's chat, and will overlay if <code>overlay</code> is set to true.
|<syntaxhighlight lang="kotlin">q.player.tell('Hello world!')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">teleport(x: Double, y: Double, z: Double, playParticleOptions: Boolean?)</syntaxhighlight>
|Teleports the player to <code>x</code>, <code>y</code>, and <code>z</code>. If <code>playParticleOptionss</code> is true then particles will be displayed.
|<syntaxhighlight lang="kotlin">q.player.teleport(0,0,0)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">heal(amount: Double?)</syntaxhighlight>
|Will heal a player by <code>amount</code>, or to max health if unspecified.
|<syntaxhighlight lang="kotlin">q.player.heal(5)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">environment(): MoLangEnvironment</syntaxhighlight>
|Returns a MoLang environment with the query set as a <code>ObjectValue<Player></code> for this player.
|<syntaxhighlight lang="kotlin">q.player.environment()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">is_player(): Double</syntaxhighlight>
|Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">p.player.is_player()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">run_command(command: String)</syntaxhighlight>
|Runs a command as the player.
|<syntaxhighlight lang="kotlin">run_command('/say Hello World!')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">is_party_at_full_health(): Double</syntaxhighlight>
|Returns if no Pokémon is able to heal, aka all is at full health.
|<syntaxhighlight lang="kotlin">q.player.is_party_at_full_health()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">can_heal_at_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Returns <code>0.0</code> if the block is not a healing machine or if the healing machine cannot heal the player's party. Otherwise returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.player.can_heal_at_healer(v.location)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">put_pokemon_in_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Attempts to heal all Pokémon in the party at the specified healing machine. Returns <code>0.0</code> if the block is not a healing machine or if the party cannot be healed. Otherwise returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.party.put_pokemon_in_healer(v.location)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">party(): ObjectValue<PartyStore></syntaxhighlight>
|Returns a struct of the player's party store.
|<syntaxhighlight lang="kotlin">q.player.party()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">pc(): ObjectValue<PCStore></syntaxhighlight>
|Returns a struct of the player's PC store.
|<syntaxhighlight lang="kotlin">q.player.pc()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">has_permission(permission: String, level: Int?)</syntaxhighlight>
|Returns <code>1.0</code> if the player has this permission at the specified <code>level</code>, otherwise returns <code>0.0</code>. <code>level</code> is 4 at default.
|<syntaxhighlight lang="kotlin">q.player.has_permission('command.pc')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">data(): VariableStruct</syntaxhighlight>
|Returns a <code>VariableStruct</code> from Cobblemon's Molang store for that player's UUID.
|<syntaxhighlight lang="kotlin">q.player.data()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">save_data()</syntaxhighlight>
|Saves to Cobblemon's Molang Store for that player's UUID.
|<syntaxhighlight lang="kotlin">q.player.save_data()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">in_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the player is in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.in_battle()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">battle(): MoValue</syntaxhighlight>
|Returns a Struct CHECK TYPE if in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.battle()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">get_npc_data(npc: MoValue): VariableStruct</syntaxhighlight>
|Get the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or an <code>ObjectValue<NPCEntity></code>.
|<syntaxhighlight lang="kotlin">q.player.get_npc_data(q.npc)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">get_npc_variable(npc: MoValue, variable: String): MoValue</syntaxhighlight>
|Get a variable from the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or a <code>ObjectValue<NPCEntity></code>. <code>variable</code> is a string key. If the key is not in the NPC data or the variable is null it will return <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.get_npc_data(q.npc, 'fight_count')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">set_npc_data(npc: MoValue, variable: String, value: MoValue, saveAfterwards: Boolean?): DoubleValue</syntaxhighlight>
|Set a variable from the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or a <code>ObjectValue<NPCEntity></code>. <code>variable</code> is used as the key and <code>value</code> is used as the value. <code>saveAfterwards</code> is true by default. Will return <code>1.0</code>
|<syntaxhighlight lang="kotlin">q.player.set_npc_data(q.npc, 'fight_count', 1)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">pokedex(): ObjectValue<AbstractPokedexManager></syntaxhighlight>
|Returns an <code>ObjectValue<AbstractPokedexManager></code> of the player's pokedex.
|<syntaxhighlight lang="kotlin">q.player.pokedex()</syntaxhighlight>
|Yes
|}

Molang Entity Functions

2025-04-19T22:07:51Z

JPAKx4: Added Entity Molang Functions

Molang Player Functions

2025-04-19T22:05:39Z

JPAKx4: /* Player Functions */

Players can also use entity functions. Type is <code>ObjectValue<Player></code>.

{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Server Only
|-
|<syntaxhighlight lang="kotlin">username(): String</syntaxhighlight>
|Returns the name of a player.
|<syntaxhighlight lang="kotlin">q.player.username()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">uuid(): String</syntaxhighlight>
|Returns the UUID of a player.
|<syntaxhighlight lang="kotlin">q.player.uuid()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">main_held_item(): ObjectValue<Item></syntaxhighlight>
|Returns the Item Object in the player's main hand.
|<syntaxhighlight lang="kotlin">q.player.main_held_item()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">off_held_item(): ObjectValue<Item></syntaxhighlight>
|Returns the Item Object in the player's off hand.
|<syntaxhighlight lang="kotlin">q.player.off_held_item()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">face(isLeftSide: Boolean?): ObjectValue<PlayerDialogueFaceProvider></syntaxhighlight>
|Returns a ObjectValue of <code>[[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/dialogue/DialogueFace.kt PlayerDialogueFaceProvider]]</code>. <code>isLeftSide</code> is true by default.
|<syntaxhighlight lang="kotlin">q.player.face()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">swing_hand()</syntaxhighlight>
|Swings the player's hand.
|<syntaxhighlight lang="kotlin">q.player.swing_hand()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">food_level(): Double</syntaxhighlight>
|Returns the food level of the player.
|<syntaxhighlight lang="kotlin">q.player.food_level()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">saturation_level(): Double</syntaxhighlight>
|Returns the saturation level of the player.
|<syntaxhighlight lang="kotlin">q.player.saturation_level()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">tell(message: String, overlay: Boolean?)</syntaxhighlight>
|Displays a message in the player's chat, and will overlay if <code>overlay</code> is set to true.
|<syntaxhighlight lang="kotlin">q.player.tell('Hello world!')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">teleport(x: Double, y: Double, z: Double, playParticleOptions: Boolean?)</syntaxhighlight>
|Teleports the player to <code>x</code>, <code>y</code>, and <code>z</code>. If <code>playParticleOptionss</code> is true then particles will be displayed.
|<syntaxhighlight lang="kotlin">q.player.teleport(0,0,0)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">heal(amount: Double?)</syntaxhighlight>
|Will heal a player by <code>amount</code>, or to max health if unspecified.
|<syntaxhighlight lang="kotlin">q.player.heal(5)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">environment(): MoLangEnvironment</syntaxhighlight>
|Returns a MoLang environment with the query set as a <code>ObjectValue<Player></code> for this player.
|<syntaxhighlight lang="kotlin">q.player.environment()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">is_player(): Double</syntaxhighlight>
|Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">p.player.is_player()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">run_command(command: String)</syntaxhighlight>
|Runs a command as the player.
|<syntaxhighlight lang="kotlin">run_command('/say Hello World!')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">is_party_at_full_health(): Double</syntaxhighlight>
|Returns if no Pokémon is able to heal, aka all is at full health.
|<syntaxhighlight lang="kotlin">q.player.is_party_at_full_health()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">can_heal_at_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Returns <code>0.0</code> if the block is not a healing machine or if the healing machine cannot heal the player's party. Otherwise returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.player.can_heal_at_healer(v.location)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">put_pokemon_in_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Attempts to heal all Pokémon in the party at the specified healing machine. Returns <code>0.0</code> if the block is not a healing machine or if the party cannot be healed. Otherwise returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.party.put_pokemon_in_healer(v.location)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">party(): ObjectValue<PartyStore></syntaxhighlight>
|Returns a struct of the player's party store.
|<syntaxhighlight lang="kotlin">q.player.party()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">pc(): ObjectValue<PCStore></syntaxhighlight>
|Returns a struct of the player's PC store.
|<syntaxhighlight lang="kotlin">q.player.pc()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">has_permission(permission: String, level: Int?)</syntaxhighlight>
|Returns <code>1.0</code> if the player has this permission at the specified <code>level</code>, otherwise returns <code>0.0</code>. <code>level</code> is 4 at default.
|<syntaxhighlight lang="kotlin">q.player.has_permission('command.pc')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">data(): VariableStruct</syntaxhighlight>
|Returns a <code>VariableStruct</code> from Cobblemon's Molang store for that player's UUID.
|<syntaxhighlight lang="kotlin">q.player.data()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">save_data()</syntaxhighlight>
|Saves to Cobblemon's Molang Store for that player's UUID.
|<syntaxhighlight lang="kotlin">q.player.save_data()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">in_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the player is in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.in_battle()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">battle(): MoValue</syntaxhighlight>
|Returns a Struct CHECK TYPE if in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.battle()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">get_npc_data(npc: MoValue): VariableStruct</syntaxhighlight>
|Get the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or an <code>ObjectValue<NPCEntity></code>.
|<syntaxhighlight lang="kotlin">q.player.get_npc_data(q.npc)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">get_npc_variable(npc: MoValue, variable: String): MoValue</syntaxhighlight>
|Get a variable from the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or a <code>ObjectValue<NPCEntity></code>. <code>variable</code> is a string key. If the key is not in the NPC data or the variable is null it will return <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.get_npc_data(q.npc, 'fight_count')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">set_npc_data(npc: MoValue, variable: String, value: MoValue, saveAfterwards: Boolean?): DoubleValue</syntaxhighlight>
|Set a variable from the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or a <code>ObjectValue<NPCEntity></code>. <code>variable</code> is used as the key and <code>value</code> is used as the value. <code>saveAfterwards</code> is true by default. Will return <code>1.0</code>
|<syntaxhighlight lang="kotlin">q.player.set_npc_data(q.npc, 'fight_count', 1)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">pokedex(): ObjectValue<AbstractPokedexManager></syntaxhighlight>
|Returns an <code>ObjectValue<AbstractPokedexManager></code> of the player's pokedex.
|<syntaxhighlight lang="kotlin">q.player.pokedex()</syntaxhighlight>
|Yes
|}

Molang Player Functions

2025-04-19T22:04:10Z

JPAKx4: Added Molang Player Functions

==Player Functions==
Players can also use entity functions. Type is <code>ObjectValue<Player></code>.
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage!!Server Only
|-
|<syntaxhighlight lang="kotlin">username(): String</syntaxhighlight>
|Returns the name of a player.
|<syntaxhighlight lang="kotlin">q.player.username()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">uuid(): String</syntaxhighlight>
|Returns the UUID of a player.
|<syntaxhighlight lang="kotlin">q.player.uuid()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">main_held_item(): ObjectValue<Item></syntaxhighlight>
|Returns the Item Object in the player's main hand.
|<syntaxhighlight lang="kotlin">q.player.main_held_item()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">off_held_item(): ObjectValue<Item></syntaxhighlight>
|Returns the Item Object in the player's off hand.
|<syntaxhighlight lang="kotlin">q.player.off_held_item()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">face(isLeftSide: Boolean?): ObjectValue<PlayerDialogueFaceProvider></syntaxhighlight>
|Returns a ObjectValue of <code>[[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/dialogue/DialogueFace.kt PlayerDialogueFaceProvider]]</code>. <code>isLeftSide</code> is true by default.
|<syntaxhighlight lang="kotlin">q.player.face()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">swing_hand()</syntaxhighlight>
|Swings the player's hand.
|<syntaxhighlight lang="kotlin">q.player.swing_hand()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">food_level(): Double</syntaxhighlight>
|Returns the food level of the player.
|<syntaxhighlight lang="kotlin">q.player.food_level()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">saturation_level(): Double</syntaxhighlight>
|Returns the saturation level of the player.
|<syntaxhighlight lang="kotlin">q.player.saturation_level()</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">tell(message: String, overlay: Boolean?)</syntaxhighlight>
|Displays a message in the player's chat, and will overlay if <code>overlay</code> is set to true.
|<syntaxhighlight lang="kotlin">q.player.tell('Hello world!')</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">teleport(x: Double, y: Double, z: Double, playParticleOptions: Boolean?)</syntaxhighlight>
|Teleports the player to <code>x</code>, <code>y</code>, and <code>z</code>. If <code>playParticleOptionss</code> is true then particles will be displayed.
|<syntaxhighlight lang="kotlin">q.player.teleport(0,0,0)</syntaxhighlight>
|
|-
|<syntaxhighlight lang="kotlin">heal(amount: Double?)</syntaxhighlight>
|Will heal a player by <code>amount</code>, or to max health if unspecified.
|<syntaxhighlight lang="kotlin">q.player.heal(5)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">environment(): MoLangEnvironment</syntaxhighlight>
|Returns a MoLang environment with the query set as a <code>ObjectValue<Player></code> for this player.
|<syntaxhighlight lang="kotlin">q.player.environment()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">is_player(): Double</syntaxhighlight>
|Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">p.player.is_player()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">run_command(command: String)</syntaxhighlight>
|Runs a command as the player.
|<syntaxhighlight lang="kotlin">run_command('/say Hello World!')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">is_party_at_full_health(): Double</syntaxhighlight>
|Returns if no Pokémon is able to heal, aka all is at full health.
|<syntaxhighlight lang="kotlin">q.player.is_party_at_full_health()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">can_heal_at_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Returns <code>0.0</code> if the block is not a healing machine or if the healing machine cannot heal the player's party. Otherwise returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.player.can_heal_at_healer(v.location)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">put_pokemon_in_healer(position: ArrayStruct<Int>): Double</syntaxhighlight>
|Attempts to heal all Pokémon in the party at the specified healing machine. Returns <code>0.0</code> if the block is not a healing machine or if the party cannot be healed. Otherwise returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.party.put_pokemon_in_healer(v.location)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">party(): ObjectValue<PartyStore></syntaxhighlight>
|Returns a struct of the player's party store.
|<syntaxhighlight lang="kotlin">q.player.party()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">pc(): ObjectValue<PCStore></syntaxhighlight>
|Returns a struct of the player's PC store.
|<syntaxhighlight lang="kotlin">q.player.pc()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">has_permission(permission: String, level: Int?)</syntaxhighlight>
|Returns <code>1.0</code> if the player has this permission at the specified <code>level</code>, otherwise returns <code>0.0</code>. <code>level</code> is 4 at default.
|<syntaxhighlight lang="kotlin">q.player.has_permission('command.pc')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">data(): VariableStruct</syntaxhighlight>
|Returns a <code>VariableStruct</code> from Cobblemon's Molang store for that player's UUID.
|<syntaxhighlight lang="kotlin">q.player.data()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">save_data()</syntaxhighlight>
|Saves to Cobblemon's Molang Store for that player's UUID.
|<syntaxhighlight lang="kotlin">q.player.save_data()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">in_battle(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the player is in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.in_battle()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">battle(): MoValue</syntaxhighlight>
|Returns a Struct CHECK TYPE if in battle, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.battle()</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">get_npc_data(npc: MoValue): VariableStruct</syntaxhighlight>
|Get the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or an <code>ObjectValue<NPCEntity></code>.
|<syntaxhighlight lang="kotlin">q.player.get_npc_data(q.npc)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">get_npc_variable(npc: MoValue, variable: String): MoValue</syntaxhighlight>
|Get a variable from the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or a <code>ObjectValue<NPCEntity></code>. <code>variable</code> is a string key. If the key is not in the NPC data or the variable is null it will return <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.player.get_npc_data(q.npc, 'fight_count')</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">set_npc_data(npc: MoValue, variable: String, value: MoValue, saveAfterwards: Boolean?): DoubleValue</syntaxhighlight>
|Set a variable from the NPC's data from the player's MoLang store. <code>npc</code> can either be the NPC's UUID or a <code>ObjectValue<NPCEntity></code>. <code>variable</code> is used as the key and <code>value</code> is used as the value. <code>saveAfterwards</code> is true by default. Will return <code>1.0</code>
|<syntaxhighlight lang="kotlin">q.player.set_npc_data(q.npc, 'fight_count', 1)</syntaxhighlight>
|Yes
|-
|<syntaxhighlight lang="kotlin">pokedex(): ObjectValue<AbstractPokedexManager></syntaxhighlight>
|Returns an <code>ObjectValue<AbstractPokedexManager></code> of the player's pokedex.
|<syntaxhighlight lang="kotlin">q.player.pokedex()</syntaxhighlight>
|Yes
|}

Molang Registry Functions

2025-04-19T22:01:26Z

JPAKx4:

==Registry ObjectValue Functions==
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">is_in(tag: ResouceLocation): Double</syntaxhighlight>
|Returns <code>1.0</code> if <code>tag</code> is in the registry, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.registry.is_in('#cobblemon:guilded_chest')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_of(identifier: ResourceLocation): Double</syntaxhighlight>
|Returns <code>1.0</code> if <code>identifier</code> is in the registry, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.registry.is_of('minecraft:dirt')</syntaxhighlight>
|}

==Biome Functions==
Can use the Registry <code>ObjectValue</code>. Type is <code>ObjectValue<Biome></code>.*
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|None :)
|
|
|}

==World Functions==
Can use the Registry <code>ObjectValue</code>. Type is <code>ObjectValue<Level></code>.*
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">game_time(): Double</syntaxhighlight>
|Returns the game time in ticks.
|<syntaxhighlight lang="kotlin">q.world.game_time()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">time_of_day(): Double</syntaxhighlight>
|Returns the <code>dayTime</code> in ticks.
|<syntaxhighlight lang="kotlin">q.world.time_of_day()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">server(): QueryStruct</syntaxhighlight>
|Returns a Server object if on a server, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.server()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_raining_at(x: Int, y: Int, z: Int): Double</syntaxhighlight>
|Takes a block position and returns <code>1.0</code> if it is raining there, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_raining_at(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_chunk_loaded_at(x: Int, y: Int, z: Int): Double</syntaxhighlight>
|Takes a block position and returns <code>1.0</code> if the chunk containing the block is loaded, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_chunk_loaded_at(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_thundering(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the the world is thundering, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_thundering()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_raining(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the the world is raining, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_raining()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">set_block(x: Int, y: Int, z: Int, block: String): Double?</syntaxhighlight>
|Take a block position and set it to be a block. Returns <code>0.0</code> and logs the unknown string if it's an invalid block. Check if world.set block returns anything
|<syntaxhighlight lang="kotlin">q.world.set_block(0, 0, 0, 'minecraft:dirt')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_block(x: Int, y: Int, z: Int): ObjectValue<Block></syntaxhighlight>
|Gets the block at the location <code>x</code>, <code>y</code>, and <code>z</code>.
|<syntaxhighlight lang="kotlin">q.world.get_block(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">spawn_explosion(x: Double, y: Double, z: Double, range: Double, interaction: String?) Check if world.explode returns anything</syntaxhighlight>
|Spawns an explosion at <code>x</code>, <code>y</code>, and <code>z</code> with range of <code>range</code>. <code>interaction</code> is a string of what kind of explosion it should be, such as <code>block</code>, <code>mob</code>, <code>tnt</code>, <code>trigger</code>, or <code>none</code>. Is <code>tnt</code> by default.
|<syntaxhighlight lang="kotlin">q.world.spawn_explosion(0, 0, 0, 3)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">spawn_lightning(x: Double, y: Double, z: Double): Double</syntaxhighlight>
|Spawns a lightning bolt at the location <code>x</code>, <code>y</code>, and <code>z</code>. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.world.spawn_lightning(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">spawn_bedrock_particles(particle: String, x: Double, y: Double, z: Double, player: MoValue?) Double?</syntaxhighlight>
|Spawns bedrock particles at the location <code>x</code>, <code>y</code>, and <code>z</code>. When run on the server, if a <code>player</code> value is specified (either a player object or a UUID) then only the <code>player</code> specified will receive the packet, otherwise all nearby players will receive it. If run on a client then it will play the animation for only that player, ignoring the <code>player</code> value, returning <code>0.0</code> if the particle is not in the registry.
|<syntaxhighlight lang="kotlin">q.world.spawn_bedrock_particles('ambient_shiny_particles', 0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_entities_around(x: Double, y: Double, z: Double, range: Double): ArrayStruct<MoValue></syntaxhighlight>
|Returns a list of entities within <code>range</code> of <code>x</code>, <code>y</code>, and <code>z</code>. This list contains the most specific MoValue for an entity, either Player, PokemonEntity, NPCEntity, or a regular Entity.
|<syntaxhighlight lang="kotlin">q.world.get_entities_around(0, 0, 0, 10)</syntaxhighlight>
|}

==Dimension Functions==
Can use the Registry <code>ObjectValue</code>. Type is <code>ObjectValue<Dimension></code>.*
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|None :)
|
|
|}

==Block Functions==
Can use the Registry <code>ObjectValue</code>. Type is <code>ObjectValue<Block></code>.*
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|None :)
|
|
|}

Footnote: *Technically the type is <code>ObjectValue<Holder<*>></code>, but for the purposes of this documentation <code>Holder</code> has been omitted.

Molang Registry Functions

2025-04-19T21:59:05Z

JPAKx4:

==Registry ObjectValue Functions==
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">is_in(tag: ResouceLocation): Double</syntaxhighlight>
|Returns <code>1.0</code> if <code>tag</code> is in the registry, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.registry.is_in('#cobblemon:guilded_chest')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_of(identifier: ResourceLocation): Double</syntaxhighlight>
|Returns <code>1.0</code> if <code>identifier</code> is in the registry, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">v.registry.is_of('minecraft:dirt')</syntaxhighlight>
|}

==Biome Functions==
Can use the Registry <code>ObjectValue</code>. Type is <code>ObjectValue<Biome></code>.*
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|None :)
|
|
|}

==World Functions==
Can use the Registry <code>ObjectValue</code>. Type is <code>ObjectValue<Level></code>.*
{| class="wikitable fixed-header sortable"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">game_time(): Double</syntaxhighlight>
|Returns the game time in ticks.
|<syntaxhighlight lang="kotlin">q.world.game_time()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">time_of_day(): Double</syntaxhighlight>
|Returns the <code>dayTime</code> in ticks.
|<syntaxhighlight lang="kotlin">q.world.time_of_day()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">server(): QueryStruct</syntaxhighlight>
|Returns a Server object if on a server, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.server()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_raining_at(x: Int, y: Int, z: Int): Double</syntaxhighlight>
|Takes a block position and returns <code>1.0</code> if it is raining there, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_raining_at(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_chunk_loaded_at(x: Int, y: Int, z: Int): Double</syntaxhighlight>
|Takes a block position and returns <code>1.0</code> if the chunk containing the block is loaded, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_chunk_loaded_at(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_thundering(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the the world is thundering, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_thundering()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_raining(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the the world is raining, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.world.is_raining()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">set_block(x: Int, y: Int, z: Int, block: String): Double?</syntaxhighlight>
|Take a block position and set it to be a block. Returns <code>0.0</code> and logs the unknown string if it's an invalid block. Check if world.set block returns anything
|<syntaxhighlight lang="kotlin">q.world.set_block(0, 0, 0, 'minecraft:dirt')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_block(x: Int, y: Int, z: Int): ObjectValue<Block></syntaxhighlight>
|Gets the block at the location <code>x</code>, <code>y</code>, and <code>z</code>.
|<syntaxhighlight lang="kotlin">q.world.get_block(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">spawn_explosion(x: Double, y: Double, z: Double, range: Double, interaction: String?) Check if world.explode returns anything</syntaxhighlight>
|Spawns an explosion at <code>x</code>, <code>y</code>, and <code>z</code> with range of <code>range</code>. <code>interaction</code> is a string of what kind of explosion it should be, such as <code>block</code>, <code>mob</code>, <code>tnt</code>, <code>trigger</code>, or <code>none</code>. Is <code>tnt</code> by default.
|<syntaxhighlight lang="kotlin">q.world.spawn_explosion(0, 0, 0, 3)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">spawn_lightning(x: Double, y: Double, z: Double): Double</syntaxhighlight>
|Spawns a lightning bolt at the location <code>x</code>, <code>y</code>, and <code>z</code>. Returns <code>1.0</code>.
|<syntaxhighlight lang="kotlin">q.world.spawn_lightning(0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">spawn_bedrock_particles(particle: String, x: Double, y: Double, z: Double, player: MoValue?) Double?</syntaxhighlight>
|Spawns bedrock particles at the location <code>x</code>, <code>y</code>, and <code>z</code>. When run on the server, if a <code>player</code> value is specified (either a player object or a UUID) then only the <code>player</code> specified will receive the packet, otherwise all nearby players will receive it. If run on a client then it will play the animation for only that player, ignoring the <code>player</code> value, returning <code>0.0</code> if the particle is not in the registry.
|<syntaxhighlight lang="kotlin">q.world.spawn_bedrock_particles('ambient_shiny_particles', 0, 0, 0)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">get_entities_around(x: Double, y: Double, z: Double, range: Double): ArrayStruct<MoValue></syntaxhighlight>
|Returns a list of entities within <code>range</code> of <code>x</code>, <code>y</code>, and <code>z</code>. This list contains the most specific MoValue for an entity, either Player, PokemonEntity, NPCEntity, or a regular Entity.
|<syntaxhighlight lang="kotlin">q.world.get_entities_around(0, 0, 0, 10)</syntaxhighlight>
|}

Footnote: *Technically the type is <code>ObjectValue<Holder<*>></code>, but for the purposes of this documentation <code>Holder</code> has been omitted.

Molang Registry Functions

2025-04-19T21:58:20Z

JPAKx4: Added Registry MoLang Functions

Molang General Functions

2025-04-19T21:55:15Z

JPAKx4: Added MoLang General Functions

These are the "Standard Functions."

{| class="wikitable fixed-header sortable fixed-header"
!Name!!Description!!Usage
|-
|<syntaxhighlight lang="kotlin">print(message: String)</syntaxhighlight>
|Logs a message into the Minecraft console.
|<syntaxhighlight lang="kotlin">q.print('Hello World!')</syntaxhighlight>
|-
|set_query
|IDK
|IDK
|-
|<syntaxhighlight lang="kotlin">replace(text: String, search: String, replace: String): String</syntaxhighlight>
|Replaces all occurrences of substring <code>search</code> inside of <code>text</code> with the value of <code>replace</code>.
|<syntaxhighlight lang="kotlin">q.replace('Hexxo Worxd!', 'x', 'l')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_blank(value: MoValue): Double</syntaxhighlight>
|Checks if the passed value is either a blank string (empty or only whitespace) or a double equal to only <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.isBlank(' ')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">run_command(command: String): Double?</syntaxhighlight>
|Runs a command, only works as a server. Returns <code>0.0</code> if run as a client.
|<syntaxhighlight lang="kotlin">q.run_command('say Hello World')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_int(val: MoValue): Double</syntaxhighlight>
|Returns <code>1.0</code> if a value is an integer, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.is_int(1)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">is_number(val: MoValue): Double</syntaxhighlight>
|Returns <code>1.0</code> a value is a double, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.is_number(3.14)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">to_number(value: MoValue): Double</syntaxhighlight>
|Tries to cast to a double, returns <code>0.0</code> if the cast fails.
|<syntaxhighlight lang="kotlin">q.to_number('3.14')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">to_int(val: MoValue): Double</syntaxhighlight>
|Tries to cast to an integer, return <code>0</code> if it fails.
|<syntaxhighlight lang="kotlin">q.to_int('3')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">to_string(val: MoValue): String</syntaxhighlight>
|Casts value to a string.
|<syntaxhighlight lang="kotlin">q.to_string(123)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">do_effect_walks(): Double</syntaxhighlight>
|Returns <code>1.0</code> if the config has <code>walkingInBattleAnimations</code> set to true, otherwise returns <code>0.0</code>.
|<syntaxhighlight lang="kotlin">q.do_effect_walks(): Double</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">random(options: MoValue...)</syntaxhighlight>
|Takes a list of values and chooses one by random.
|<syntaxhighlight lang="kotlin">q.random(1, 2, 3, 4, 5)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">curve(curveName: String): ObjectValue<(Float) -> Float></syntaxhighlight>
|Returns a WaveFunction by the <code>curveName</code>. ([https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/wavefunction/WaveFunction.kt?ref_type=heads#L102 Options found here])
|<syntaxhighlight lang="kotlin">q.curve('symmetrical')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">array(values: MoValue...): ArrayStruct<MoValue></syntaxhighlight>
|Returns an array from the parameters.
|<syntaxhighlight lang="kotlin">q.array(1, 2, 3, 4, 5)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">run_script(identifier: String): MoValue</syntaxhighlight>
|Runs a script from an <code>identifier</code>. Returns the result of the script or <code>0.0</code> if it fails.
|<syntaxhighlight lang="kotlin">q.run_script('cobblemon:npc_battle_cooling_down')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">run_molang(expression: String): MoValue</syntaxhighlight>
|Parses a MoLang expression and resolves it using the same context as the MoLang that called it.
|<syntaxhighlight lang="kotlin">q.run_molang('q.print(\'Hello World!\')')</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">system_time_millis(): Double</syntaxhighlight>
|Returns the value of the system’s time in milliseconds.
|<syntaxhighlight lang="kotlin">q.system_time_millis()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">date_local_time(): String</syntaxhighlight>
|Returns the current date in "DD/MM/YYYY" format.
|<syntaxhighlight lang="kotlin">q.date_local_time()</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">date_of(millis: Double): String</syntaxhighlight>
|Takes epoch milliseconds and formats it in "DD/MM/YYYY" format.
|<syntaxhighlight lang="kotlin">q.date_of(1000000)</syntaxhighlight>
|-
|<syntaxhighlight lang="kotlin">date_is_after(dateA: String, dateB: String): Double</syntaxhighlight>
|Takes two dates in format "DD/MM/YYYY" and returns <code>1.0</code> if the first date is after the second date.
|<syntaxhighlight lang="kotlin">q.date_is_after('01/01/2024', '02/01/2024')</syntaxhighlight>
|}

Molang Types

2025-04-19T21:54:28Z

JPAKx4: /* Types */

This is a table of types used in Cobblemon as documented, and the classes they extend from.

{| class="wikitable fixed-header sortable"
!Name!!Type!!Description
|-
|<code>MoValue</code>
|Class
|This is the parent class of all values. Does nothing on it's own, can be treated like <code>Any</code> in Kotlin.
|-
|<code>DoubleValue</code>
|Subclass of MoValue
|Doubles are also used as Integers and Booleans.
|-
|<code>StringValue</code>
|Subclass of MoValue
|Represents a String.
|-
|<code>MoStruct</code>
|Subclass of MoValue
|Used like a map, can get or set using a string key.
|-
|<code>VariableStruct</code>
|Subclass of MoStruct
|A struct that can get and set values.
|-
|<code>ArrayStruct</code>
|Subclass of VariableStruct
|A struct that uses integers as keys. NOTE: For the purpose of documentation, ArrayStruct is notated as <code>ArrayStruct<Type></code> when only one type is expected. All <code>ArrayStruct</code>s have no required types and can be mixed.
|-
|<code>QueryStruct</code>
|Subclass of MoStruct
|A struct that contains functions that can be executed using get. Does not support setting values.
|-
|<code>ObjectValue</code>
|Subclass of QueryStruct
|Cobblemon class used to implement many types. Can get the value of the type, get a double value using <code>asDouble()</code>, and get a string value using <code>asString()</code>. This is used for Players, Pokémon, Battles, and the rest of our implemented Minecraft and Cobblemon types. These may have special functions which are listed below.
|}

Molang Types

2025-04-19T21:51:31Z

JPAKx4: Added MoLang Types page

=Types=

This is a table of types used in Cobblemon as documented, and the classes they extend from.

{| class="wikitable fixed-header sortable"
!Name!!Type!!Description
|-
|<code>MoValue</code>
|Class
|This is the parent class of all values. Does nothing on it's own, can be treated like <code>Any</code> in Kotlin.
|-
|<code>DoubleValue</code>
|Subclass of MoValue
|Doubles are also used as Integers and Booleans.
|-
|<code>StringValue</code>
|Subclass of MoValue
|Represents a String.
|-
|<code>MoStruct</code>
|Subclass of MoValue
|Used like a map, can get or set using a string key.
|-
|<code>VariableStruct</code>
|Subclass of MoStruct
|A struct that can get and set values.
|-
|<code>ArrayStruct</code>
|Subclass of VariableStruct
|A struct that uses integers as keys. NOTE: For the purpose of documentation, ArrayStruct is notated as <code>ArrayStruct<Type></code> when only one type is expected. All <code>ArrayStruct</code>s have no required types and can be mixed.
|-
|<code>QueryStruct</code>
|Subclass of MoStruct
|A struct that contains functions that can be executed using get. Does not support setting values.
|-
|<code>ObjectValue</code>
|Subclass of QueryStruct
|Cobblemon class used to implement many types. Can get the value of the type, get a double value using <code>asDouble()</code>, and get a string value using <code>asString()</code>. This is used for Players, Pokémon, Battles, and the rest of our implemented Minecraft and Cobblemon types. These may have special functions which are listed below.
|}

User:JPAKx4

2025-04-19T18:04:34Z

JPAKx4: Blanked the page

User:JPAKx4

2025-04-19T18:02:44Z

JPAKx4: /* Types */

=MoLang Types=
Cobblemon uses [https://github.com/bedrockk/MoLang Bedrockk MoLang] to parse and execute MoLang. This is a table of types used in Cobblemon as documented, and the class it extends from.

=MoLang Functions=
{| class="wikitable fixed-header sortable"
!Name!!Type!!Description
|-
|<code>MoValue</code>
|Class
|This is the parent class of all values. Does nothing on it's own, can be treated like <code>Any</code> in Kotlin.
|-
|<code>DoubleValue</code>
|Subclass of MoValue
|Doubles are also used as Integers and Booleans.
|-
|<code>StringValue</code>
|Subclass of MoValue
|Represents a String.
|-
|<code>MoStruct</code>
|Subclass of MoValue
|Used like a map, can get or set using a string key.
|-
|<code>VariableStruct</code>
|Subclass of MoStruct
|A struct that can get and set values.
|-
|<code>ArrayStruct</code>
|Subclass of VariableStruct
|A struct that uses integers as keys. NOTE: For the purpose of documentation, ArrayStruct is notated as <code>ArrayStruct<Type></code> when only one type is expected. All <code>ArrayStruct</code>s have no required types and can be mixed.
|-
|<code>QueryStruct</code>
|Subclass of MoStruct
|A struct that contains functions that can be executed using get. Does not support setting values.
|-
|<code>ObjectValue</code>
|Subclass of QueryStruct
|Cobblemon class used to implement many types. Can get the value of the type, get a double value using <code>asDouble()</code>, and get a string value using <code>asString()</code>. This is used for Players, Pokémon, Battles, and the rest of our implemented Minecraft and Cobblemon types. These may have special functions which are listed below.
|}

User:JPAKx4

2025-04-19T18:02:29Z

JPAKx4: Added MoLang Types page

=Types=
Cobblemon uses [https://github.com/bedrockk/MoLang Bedrockk MoLang] to parse and execute MoLang. This is a table of types used in Cobblemon as documented, and the class it extends from.

=MoLang Functions=
{| class="wikitable fixed-header sortable"
!Name!!Type!!Description
|-
|<code>MoValue</code>
|Class
|This is the parent class of all values. Does nothing on it's own, can be treated like <code>Any</code> in Kotlin.
|-
|<code>DoubleValue</code>
|Subclass of MoValue
|Doubles are also used as Integers and Booleans.
|-
|<code>StringValue</code>
|Subclass of MoValue
|Represents a String.
|-
|<code>MoStruct</code>
|Subclass of MoValue
|Used like a map, can get or set using a string key.
|-
|<code>VariableStruct</code>
|Subclass of MoStruct
|A struct that can get and set values.
|-
|<code>ArrayStruct</code>
|Subclass of VariableStruct
|A struct that uses integers as keys. NOTE: For the purpose of documentation, ArrayStruct is notated as <code>ArrayStruct<Type></code> when only one type is expected. All <code>ArrayStruct</code>s have no required types and can be mixed.
|-
|<code>QueryStruct</code>
|Subclass of MoStruct
|A struct that contains functions that can be executed using get. Does not support setting values.
|-
|<code>ObjectValue</code>
|Subclass of QueryStruct
|Cobblemon class used to implement many types. Can get the value of the type, get a double value using <code>asDouble()</code>, and get a string value using <code>asString()</code>. This is used for Players, Pokémon, Battles, and the rest of our implemented Minecraft and Cobblemon types. These may have special functions which are listed below.
|}