JPAKx4: Add Molang NPC Functions

2025-04-19T22:17:55Z

Add Molang NPC Functions

New page

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 NPC Functions - Revision history

JPAKx4: Add Molang NPC Functions