onShopOpened

Purpose

Triggered when a player opens a shop's UI. Use this hook to play sounds, show welcome messages, start animations, or track analytics.

When It Triggers

  • Player interacts with a shop and the shop UI is displayed

  • Fires after all shop data has been loaded and sent to the UI

Parameters

Parameter
Type
Description

data.shopId

string

Unique shop identifier

data.shopType

string

Type of shop (e.g., '247store', 'liquorstore')

data.shopName

string

Display name of the shop

data.isShopOwned

boolean

Whether the shop has a player owner

data.ownerName

string

Owner's name (nil if not owned)

data.shopCoords

vector3

Shop location coordinates

data.isEmployee

boolean

Whether the player is an employee

data.isOwner

boolean

Whether the player is the owner

data.playerPermissions

table

Array of player's permissions (if employee/owner)

Example

Last updated