JPAKx4: Add link to Entity Functions

2025-04-19T22:08:52Z

Add link to Entity Functions

← Older revision		Revision as of 22:08, 19 April 2025
Line 1:		Line 1:
	Players can also use entity functions. Type is <code>ObjectValue<Player></code>.		Players can also use [[Molang Entity Functions\|entity functions]]. Type is <code>ObjectValue<Player></code>.

	{\| class="wikitable fixed-header sortable"		{\| class="wikitable fixed-header sortable"

JPAKx4: /* Player Functions */

2025-04-19T22:05:39Z

Player Functions

← Older revision		Revision as of 22:05, 19 April 2025
Line 1:		Line 1:
	~~==Player Functions==~~
	Players can also use entity functions. Type is <code>ObjectValue<Player></code>.		Players can also use entity functions. Type is <code>ObjectValue<Player></code>.

	{\| class="wikitable fixed-header sortable"		{\| class="wikitable fixed-header sortable"
	!Name!!Description!!Usage!!Server Only		!Name!!Description!!Usage!!Server Only

JPAKx4: Added Molang Player Functions

2025-04-19T22:04:10Z

Added Molang Player Functions

New page

==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 - Revision history

JPAKx4: Add link to Entity Functions

JPAKx4: /* Player Functions */

JPAKx4: Added Molang Player Functions