Skip to content
Adam Matthiesen's MC Development
These docs are a work in progress and may be incomplete or contain inaccuracies. (Or be for a newer unreleased version of the mod)

Cobblemon NPC GriefDefender Compatibility - Molang Extensions

Cobblemon NPC GriefDefender Compatibility provides the following Molang extensions for use in Cobblemon NPC Molang functionality:

General Notes

Section titled “General Notes”
  • Boolean-style functions return 1 for true and 0 for false.
  • Numeric values are exposed as Molang numbers.
  • Claim lookup functions generally return 0 when nothing is found.

Data Shapes

Section titled “Data Shapes”

These object formats are reused by multiple functions.

SimpleClaimData

Section titled “SimpleClaimData”
  • uuid
  • displayName
  • ownerUUID
  • ownerName

RentalClaimData

Section titled “RentalClaimData”
  • uuid
  • displayName
  • ownerUUID
  • ownerName
  • isForRent
  • isRented
  • rentalRate
  • renter
  • paymentType
  • rentMinTime
  • rentMaxTime

ForSaleClaimData

Section titled “ForSaleClaimData”
  • uuid
  • displayName
  • ownerUUID
  • ownerName
  • isForSale
  • salePrice

ClaimTaxData

Section titled “ClaimTaxData”
  • uuid
  • displayName
  • ownerUUID
  • ownerName
  • spawnPos
  • taxPastDueDate
  • taxBalance

Universal Functions

Section titled “Universal Functions”

These functions are available in multiple Molang contexts.

gd_economy_enabled()

Section titled “gd_economy_enabled()”
  • Available on: q.npc, q.player, q.server, q.world
  • Returns: 1 if claim economy is enabled, otherwise 0

gd_get_player_claims(<uuid>)

Section titled “gd_get_player_claims(<uuid>)”
  • Available on: q.npc, q.server, q.world
  • Argument: player UUID
  • Returns: an array of SimpleClaimData

NPC Functions

Section titled “NPC Functions”

These functions are available on q.npc.

gd_is_wilderness()

Section titled “gd_is_wilderness()”
  • Returns: 1 if the NPC is standing in wilderness, otherwise 0

gd_claim_data()

Section titled “gd_claim_data()”
  • Returns: SimpleClaimData for the NPC’s current location, or 0 if none exists

gd_claim_uuid()

Section titled “gd_claim_uuid()”
  • Returns: the claim UUID as a string, or 0 if none exists

gd_claim_name()

Section titled “gd_claim_name()”
  • Returns: the claim name as a string, or 0 if none exists

gd_claim_owner_uuid()

Section titled “gd_claim_owner_uuid()”
  • Returns: the owner UUID as a string, or 0 if none exists

gd_claim_owner_name()

Section titled “gd_claim_owner_name()”
  • Returns: the owner name as a string, or 0 if none exists

gd_available_rentals()

Section titled “gd_available_rentals()”
  • Returns: an array of RentalClaimData

gd_available_forsale()

Section titled “gd_available_forsale()”
  • Returns: an array of ForSaleClaimData

gd_claim_rental_data()

Section titled “gd_claim_rental_data()”
  • Returns: RentalClaimData for the NPC’s current location, or 0 if none exists

gd_claim_sale_data()

Section titled “gd_claim_sale_data()”
  • Returns: ForSaleClaimData for the NPC’s current location, or 0 if none exists

gd_tax_data()

Section titled “gd_tax_data()”
  • Returns: ClaimTaxData for the NPC’s current location, or 0 if none exists

Player Functions

Section titled “Player Functions”

These functions are available on q.player.

gd_claims()

Section titled “gd_claims()”
  • Returns: an array of SimpleClaimData for the active player

gd_current_claim()

Section titled “gd_current_claim()”
  • Returns: the UUID of the claim the player is currently in, or 0

gd_accrued_claim_blocks()

Section titled “gd_accrued_claim_blocks()”
  • Returns: accrued claim blocks as an integer

gd_blocks_accrued_per_hour()

Section titled “gd_blocks_accrued_per_hour()”
  • Returns: claim blocks earned per hour as an integer

gd_max_accrued_claim_blocks()

Section titled “gd_max_accrued_claim_blocks()”
  • Returns: the maximum accrued claim blocks as an integer

gd_max_bonus_claim_blocks()

Section titled “gd_max_bonus_claim_blocks()”
  • Returns: the maximum bonus claim blocks as an integer

gd_max_claim_level()

Section titled “gd_max_claim_level()”
  • Returns: the maximum claim level as an integer

gd_min_claim_level()

Section titled “gd_min_claim_level()”
  • Returns: the minimum claim level as an integer

gd_bonus_claim_blocks()

Section titled “gd_bonus_claim_blocks()”
  • Returns: bonus claim blocks as an integer

gd_initial_claim_blocks()

Section titled “gd_initial_claim_blocks()”
  • Returns: initial claim blocks as an integer

gd_remaining_claim_blocks()

Section titled “gd_remaining_claim_blocks()”
  • Returns: remaining claim blocks as an integer

gd_max_claimable_blocks()

Section titled “gd_max_claimable_blocks()”
  • Returns: the maximum claimable blocks as an integer

gd_rental_limit()

Section titled “gd_rental_limit()”
  • Returns: the rental limit as an integer

gd_available_rentals()

Section titled “gd_available_rentals()”
  • Returns: an array of RentalClaimData

gd_available_forsale()

Section titled “gd_available_forsale()”
  • Returns: an array of ForSaleClaimData

gd_start_purchase(<claimUUID>)

Section titled “gd_start_purchase(<claimUUID>)”
  • Argument: claim UUID
  • Returns: 1 if the purchase process was completed successfully, otherwise 0

Server Functions

Section titled “Server Functions”

These functions are available on q.server.

gd_get_player_claims(<uuid>)

Section titled “gd_get_player_claims(<uuid>)”
  • Argument: player UUID
  • Returns: an array of SimpleClaimData

World Functions

Section titled “World Functions”

These functions are available on q.world.

gd_is_wilderness(x, y, z)

Section titled “gd_is_wilderness(x, y, z)”
  • Arguments: world coordinates
  • Returns: 1 if the location is wilderness, otherwise 0

gd_get_claim_uuid(x, y, z)

Section titled “gd_get_claim_uuid(x, y, z)”
  • Arguments: world coordinates
  • Returns: the claim UUID as a string, or 0 if none exists

gd_get_claim_name(x, y, z)

Section titled “gd_get_claim_name(x, y, z)”
  • Arguments: world coordinates
  • Returns: the claim name as a string, or 0 if none exists

gd_get_claim_owner_uuid(x, y, z)

Section titled “gd_get_claim_owner_uuid(x, y, z)”
  • Arguments: world coordinates
  • Returns: the owner UUID as a string, or 0 if none exists

gd_get_claim_owner_name(x, y, z)

Section titled “gd_get_claim_owner_name(x, y, z)”
  • Arguments: world coordinates
  • Returns: the owner name as a string, or 0 if none exists

gd_available_rentals()

Section titled “gd_available_rentals()”
  • Returns: an array of RentalClaimData

gd_available_forsale()

Section titled “gd_available_forsale()”
  • Returns: an array of ForSaleClaimData

Example Usage

Section titled “Example Usage”
q.player.gd_remaining_claim_blocks()
q.world.gd_is_wilderness(0, 64, 0)
q.npc.gd_claim_data()
q.npc.gd_claim_owner_name()
q.npc.gd_claim_rental_data()
q.npc.gd_claim_sale_data()
q.npc.gd_tax_data()
q.player.gd_available_forsale()
q.world.gd_available_forsale()