Parameters

• client Player

  Player that is creating the character

• payload table

  Table of data to be used for character creation

• newPayload table

  Table of data be merged with the current payload

Example Usage

function PLUGIN:AdjustCreationPayload(client, payload, newPayload)
	newPayload.money = payload.attributes["stm"] -- Sets the characters initial money to the stamina attribute value.
end

Parameters

• client Player

  Player whose stamina is changing

• baseOffset number

  Amount the stamina is changing by. This can be a positive or negative number depending if they are exhausting or regaining stamina

Returns

• number

  New offset to use

Example Usage

function PLUGIN:AdjustStaminaOffset(client, baseOffset)
	return baseOffset * 2 -- Drain/Regain stamina twice as fast.
end

Returns

• bool

  Whether or not to create the business menu

Example Usage

function PLUGIN:BuildBusinessMenu()
	return LocalPlayer():IsAdmin() -- Only builds the business menu for admins.
end

Parameters

• speaker Player

  Player that sent the message

• chatType string

  Chat type of the message. This will be something registered with ix.chat.Register - like ic, ooc, etc.

• text string

  Unformatted text of the message

Returns

• bool

  Whether or not to allow auto formatting on the message

Example Usage

function PLUGIN:CanAutoFormatMessage(speaker, chatType, text)
	return false -- Disable auto formatting outright.
end

Parameters

• suppress table

  Information to NOT display in the UI - modify this to change the behaviour. This is a table of the names of some panels to avoid displaying. Valid names include:

  • time - current in-game time
  • name - name of the character
  • description - description of the character
  • characterInfo - entire panel showing a list of additional character info
  • faction - faction name of the character
  • class - name of the character's class if they're in one
  • money - current money the character has
  • attributes - attributes list for the character

  Note that schemas/plugins can add additional character info panels.

Example Usage

function PLUGIN:CanCreateCharacterInfo(suppress)
	suppress.attributes = true -- Hides the attributes panel from the character info tab
end

Parameters

• weapon Entity

  Weapon the player currently is holding

Returns

• bool

  Whether or not to draw the ammo hud

Example Usage

function PLUGIN:CanDrawAmmoHUD(weapon)
	if (weapon:GetClass() == "weapon_frag") then -- Hides the ammo hud when holding grenades.
		return false
	end
end

Parameters

• client Player

  The client trying something on the door.

• door Entity

  The door entity itself.

• access number

  The access level used when called.

Returns

• bool

  Whether or not to allow the client access.

Example Usage

function PLUGIN:CanPlayerAccessDoor(client, door, access)
	return true -- Always allow access.
end

Parameters

• client Player

  Player attempting to combine an item into another

• item number

  instance ID of the item being dropped onto

• other number

  instance ID of the item being combined into the first item, this can be invalid due to it being from clientside

Returns

• bool

  Whether or not to allow the player to combine the items

Example Usage

function PLUGIN:CanPlayerCombineItem(client, item, other)
	local otherItem = ix.item.instances[other]

	if (otherItem and otherItem.uniqueID == "soda") then
		return false -- disallow combining any item that has a uniqueID equal to `soda`
	end
end

Parameters

• client Player

  Player attempting to create a new character

• payload table

  Data that is going to be used for creating the character

Returns

• bool

  Whether or not the player is allowed to create the character. This function defaults to true, so you should only ever return false if you're disallowing creation. Otherwise, don't return anything as you'll prevent any other calls to this hook from running.

• string

  Language phrase to use for the error message

• ...

  Arguments to use for the language phrase

Example Usage

function PLUGIN:CanPlayerCreateCharacter(client, payload)
	if (!client:IsAdmin()) then
		return false, "notNow" -- only allow admins to create a character
	end
end
-- non-admins will see the message "You are not allowed to do this right now!"

Parameters

• client Player

  Player attempting to drop an item

• item number

  instance ID of the item being dropped

Returns

• bool

  Whether or not to allow the player to drop the item

Example Usage

function PLUGIN:CanPlayerDropItem(client, item)
	return false -- Never allow dropping items.
end

Parameters

• client Player

  Player to give money to

• faction table

  Faction of the player's character

Returns

• bool

  Whether or not to allow the player to earn salary

Example Usage

function PLUGIN:CanPlayerEarnSalary(client, faction)
	return client:IsAdmin() -- Restricts earning salary to admins only.
end

Parameters

• client Player

  Player attempting to enter observer

Returns

• bool

  Whether or not to allow the player to enter observer

Example Usage

function PLUGIN:CanPlayerEnterObserver(client)
	return true -- Always allow observer.
end

Parameters

• client Player

  Player attempting to equip the item

• item table

  Item being equipped

Returns

• bool

  Whether or not to allow the player to equip the item

Example Usage

function PLUGIN:CanPlayerEquipItem(client, item)
	return client:IsAdmin() -- Restrict equipping items to admins only.
end

See Also

• CanPlayerUnequipItem

Parameters

• client Player

  Player attempting to hold an entity

• entity Entity

  Entity being held

Returns

• bool

  Whether or not to allow the player to hold the entity

Example Usage

function PLUGIN:CanPlayerHoldObject(client, entity)
	return !(client:GetMoveType() == MOVETYPE_NOCLIP and !client:InVehicle()) -- Disallow players in observer holding objects.
end

Parameters

• client Player

  Player attempting interaction

• entity Entity

  Entity being interacted with

• option string

  Option selected by the player

• data

  Any data passed with the interaction option

Returns

• bool

  Whether or not to allow the player to interact with the entity

Example Usage

function PLUGIN:CanPlayerInteractEntity(client, entity, option, data)
	return false -- Disallow interacting with any entity.
end

Parameters

• client Player

  Player attempting interaction

• action string

  The action being performed

• item

  Item's instance ID or item table

• data

  Any data passed with the action

Returns

• bool

  Whether or not to allow the player to interact with the item

Example Usage

function PLUGIN:CanPlayerInteractItem(client, action, item, data)
	return false -- Disallow interacting with any item.
end

Parameters

• client Player

  Player attempting to join

• class number

  ID of the class

• info table

  The class table

Returns

• bool

  Whether or not to allow the player to join the class

Example Usage

function PLUGIN:CanPlayerJoinClass(client, class, info)
	return client:IsAdmin() -- Restrict joining classes to admins only.
end

Parameters

• client Player

  Player attempting to knock

• entity Entity

  Door being knocked on

Returns

• bool

  Whether or not to allow the player to knock on the door

Example Usage

function PLUGIN:CanPlayerKnock(client, entity)
	return false -- Disable knocking on doors outright.
end

Parameters

• client Player

  Player attempting to open the shipment

• entity Entity

  Shipment entity

Returns

• bool

  Whether or not to allow the player to open the shipment

Example Usage

function PLUGIN:CanPlayerOpenShipment(client, entity)
	return client:Team() == FACTION_BMD -- Restricts opening shipments to FACTION_BMD.
end

Parameters

• client Player

  Player attempting to spawn a container

• model string

  Model of the container being spawned

• entity Entity

  Container entity

Returns

• bool

  Whether or not to allow the player to spawn the container

Example Usage

function PLUGIN:CanPlayerSpawnContainer(client, model, entity)
	return client:IsAdmin() -- Restrict spawning containers to admins.
end

Parameters

• client Player

  Player attempting to take the item

• item Entity

  Entity corresponding to the item

Returns

• bool

  Whether or not to allow the player to take the item

Example Usage

function PLUGIN:CanPlayerTakeItem(client, item)
	return !(client:GetMoveType() == MOVETYPE_NOCLIP and !client:InVehicle()) -- Disallow players in observer taking items.
end

Parameters

• client Player

  Player attempting throw a punch

Returns

• bool

  Whether or not to allow the player to punch

Example Usage

function PLUGIN:CanPlayerThrowPunch(client)
	return client:GetCharacter():GetAttribute("str", 0) > 0 -- Only allow players with strength to punch.
end

Parameters

• client Player

  Player attempting to trade

• entity Entity

  Vendor entity

• uniqueID string

  The uniqueID of the item being traded.

• isSellingToVendor boolean

  If the client is selling to the vendor

Returns

• bool

  Whether or not to allow the client to trade with the vendor

Example Usage

function PLUGIN:CanPlayerTradeWithVendor(client, entity, uniqueID, isSellingToVendor)
	return false -- Disallow trading with vendors outright.
end

Parameters

• client Player

  Player attempting to unequip an item

• item table

  Item being unequipped

Returns

• bool

  Whether or not to allow the player to unequip the item

Example Usage

function PLUGIN:CanPlayerUnequipItem(client, item)
	return false -- Disallow unequipping items.
end

See Also

• CanPlayerEquipItem

Parameters

• client Player

  Player that uses a business menu

• uniqueID string

  The uniqueID of the business menu item

Returns

• bool

  Whether or not to allow the player to buy an item from the business menu

Example Usage

function PLUGIN:CanPlayerUseBusiness(client, uniqueID)
 return false -- Disallow buying from the business menu.
end

Parameters

• client Player

  Player that wants to use a character

• character Character

  Character that a player wants to use

Returns

• bool

  Whether or not to allow the player to load a character

Example Usage

function PLUGIN:CanPlayerUseCharacter(client, character)
	return false -- Disallow using any character.
end

Parameters

• client Player

  Player that wants to use a door

• entity Entity

  Door that a player wants to use

Returns

• bool

  Whether or not to allow the player to use a door

Example Usage

function PLUGIN:CanPlayerUseDoor(client, character)
	return false -- Disallow using any door.
end

Parameters

• activator Player

  The player attempting to use the vendor

• vendor Entity

  The vendor entity being used

Returns

• bool

  Returns false if the player can't use the vendor

Returns

• bool

  Whether or not to allow the player to view his inventory

Example Usage

function PLUGIN:CanPlayerViewInventory()
	return false -- Prevent player from viewing his inventory.
end

Parameters

• entity Entity

  Container entity to save

• inventory table

  Container inventory

Returns

• bool

  Whether or not to save a container

Example Usage

function PLUGIN:CanSaveContainer(entity, inventory)
 return false -- Disallow saving any container.
end

Parameters

• item

• currentInv

• oldInv

Parameters

• client

• character

• attribID

• boostID

• boostAmount

Parameters

• client

• self

• key

• value

Parameters

• client

• id

• isCurrentChar

Parameters

• self

• flags

Parameters

• character

Parameters

• character Character

  that was saved

Parameters

• character

Parameters

• character Character

  that was restored

Parameters

• character

• key

• oldVar

• value

Parameters

• client

• entity

• uniqueID

• isSellingToVendor

Parameters

• x

• y

• width

• height

Parameters

• color

Parameters

• container Entity

  Container that was removed

• inventory table

  Container inventory

Parameters

• panel

Parameters

• panel

Parameters

• icon

• menu

• itemTable

Parameters

• tabs

Parameters

• client Player

  Player that ordered the shipment

• entity Entity

  Shipment entity

Parameters

• error string

  Error that prevented server from connecting to the database

Parameters

• path

• pluginTable

Parameters

• panel

• entity

Parameters

• entity

Parameters

• client

Parameters

• speaker

• chatType

Parameters

• text

Parameters

• curAlpha

Parameters

• client

• count

Parameters

• client

• faction

Parameters

• client

Parameters

• client Player

  Player that died

Returns

• string

  Sound to play

OR
• bool

  false if a sound shouldn't be played at all

Example Usage

function PLUGIN:GetPlayerDeathSound(client)
	-- play impact sound every time someone dies
	return "physics/body/body_medium_impact_hard1.wav"
end

function PLUGIN:GetPlayerDeathSound(client)
	-- don't play a sound at all
	return false
end

Parameters

• client

• options

Parameters

• speaker

Parameters

• client Player

  Client that received damage

Returns

• string

  Sound to emit

Example Usage

function PLUGIN:GetPlayerPainSound(client)
	return "NPC_MetroPolice.Pain" -- Make players emit MetroPolice pain sound.
end

Parameters

• client

• damage

• context

Parameters

• client Player

  Client that is receiving salary

• faction table

  Faction of the player's character

Returns

• number

  Character salary

Example Usage

function PLUGIN:GetSalaryAmount(client, faction)
 return 0 -- Everyone get no salary.
end

See Also

• CanPlayerEarnSalary

Parameters

• character

• text

Example Usage

function PLUGIN:InitializedChatClasses()
	-- let's say you wanted to reference an existing chat class's color
	ix.chat.Register("myclass", {
		format = "%s says \"%s\"",
		GetColor = function(self, speaker, text)
			-- make the chat class slightly brighter than the "ic" chat class
			local color = ix.chat.classes.ic:GetColor(speaker, text)

			return Color(color.r + 35, color.g + 35, color.b + 35)
		end,
		-- etc.
	})
end

See Also

• ix.chat.Register
• ix.chat.classes

Parameters

• oldInv table

  Previous item inventory

• inventory table

  New item inventory

• item table

  Item that was added to the inventory

Parameters

• inventory table

  Inventory from which item was removed

• item table

  Item that was removed from the inventory

Parameters

• character

• id

Parameters

• client

Parameters

• chatType

Parameters

• font

• genericFont

Parameters

• subpanelName

• panel

Parameters

• client

• info

Parameters

• oldID

• newID

Parameters

• client

• character

Parameters

• client Player

  The player that has disconnected

• character Character

  The character that the player was using

Parameters

• client Player

  Player that was ragdolled or unradolled

• entity Entity

  Ragdoll that represents the player

• bFallenOver boolean

  Whether or not the character was ragdolled or unragdolled

Parameters

• client Player

  Player that has gotten up

• ragdoll Entity

  Ragdoll used to represent the player

Parameters

• panel

Parameters

• entity Entity

  Spawned item entity

Example Usage

function PLUGIN:OnItemSpawned(entity)
	local item = entity:GetItemTable()
	-- do something with the item here
end

Parameters

• item

• curInv

• inventory

Parameters

• key

• var

Parameters

• part

Parameters

• client Player

  Player that picked up the money

• self Entity

  Money entity

Returns

• bool

  Whether or not to allow the player to pick up the money

Example Usage

function PLUGIN:OnPickupMoney(client, self)
	return false -- Disallow picking up money.
end

Parameters

• client

• oldID

• newID

Parameters

• client Player

  Player that entered or exited the observer mode

• state boolean

  Previous observer state

Parameters

• client Player

  Player that other player has interacted with

• callingClient Player

  Player that has interacted with with other player

• option string

  Option that was selected

Parameters

• client Player

  Player that has purchased or sold a door

• entity Entity

  Door that was purchased or sold

• bBuying boolean

  Whether or not the player is bying a door

• bCallOnDoorChild function

  Function to call something on the door child

Parameters

• client Player

  Player that was restricted

Parameters

• client Player

  Player that was unrestricted

Parameters

• loadedItems table

  Table of items that were loaded

Parameters

• client

• sequence

• callback

• time

• bNoFreeze

Parameters

• client Player

  Player that performed interaction

• entity Entity

  Entity being interacted with

• option string

  Option selected by the player

• data

  Any data passed with the interaction option

Parameters

• client Player

  Player that interacted with an item

• action string

  Action selected by the player

• item table

  Item being interacted with

Parameters

• client Player

  Player that has joined a class

• class number

  Index of the class player has joined to

• oldClass number

  Index of the player's previous class

Parameters

• entity

Parameters

• client Player

  Player that has loaded a character

• character Character

  Character that was loaded

• currentChar Character

  Character that player was using

Parameters

• client Player

  Player that has locked a door

• door Entity

  Door that was locked

• partner Entity

  Door partner

Parameters

• client Player

  Player that has locked a vehicle

• vehicle Entity

  Vehicle that was locked

Parameters

• speaker Player

  Player that has said something in the text chat

• chatType string

  Type of the chat that player used

• text string

  Chat message that player send

• anonymous boolean

  Whether or not message was anonymous

• receivers table

  Players who will hear that message

• rawText string

  Chat message without any formatting

Returns

• string

  You can return text that will be shown instead

Example Usage

function PLUGIN:PlayerMessageSend(speaker, chatType, text, anonymous, receivers, rawText)
 return "Text" -- When a player writes something into chat, he will say "Text" instead.
end

Parameters

• client Player

  Player whose model was changed

• oldModel string

  Old player model

Parameters

• client Player

  Player who has got stamina

Parameters

• client Player

  Player who has lost stamina

Parameters

• client

• trace

Parameters

• client Player

  Player that has unlocked a door

• door Entity

  Door that was unlocked

• partner Entity

  Door partner

Parameters

• client Player

  Player that has unlocked a vehicle

• vehicle Entity

  Vehicle that was unlocked

Parameters

• client Player

  Player who has used an entity

• entity Entity

  Entity that was used by the player

Parameters

• client Player

  Player who has used a door

• entity Entity

  Door that was used by the player

Parameters

• client

• weapon

Parameters

• uniqueID

• pluginTable

Parameters

• uniqueID

Parameters

• uniqueID

Parameters

• client

• character

• tooltip

Parameters

• entity

• tooltip

Parameters

• categories

Parameters

• entity

• character

• tooltip

Parameters

• tooltip

• item

Parameters

• client

• tooltip

Parameters

• client

• menu

Parameters

• width

• height

• alpha

Parameters

• panel

• entity

Parameters

• panel

Parameters

• client Player

Parameters

• client Player

  Player that has said something in the text chat

• chatType string

  Type of the chat that player used

• message string

  Chat message that player send

• anonymous boolean

  Whether or not message was anonymous

Parameters

• client Player

  Character owner

• character Character

  Chraracter that will be deleted

Parameters

• client Player

  Player that loading a character

• character Character

  Character that will be loaded

• currentChar Character

  Character that player is using

Parameters

• client Player

  Player sending the message

• chatType string

  Chat class of the message

• message string

  Contents of the message

• bAnonymous boolean

  Whether or not the player is sending the message anonymously

Returns

• bool

  Whether or not to prevent the message from being sent

Example Usage

function PLUGIN:PrePlayerMessageSend(client, chatType, message, bAnonymous)
	if (!client:IsAdmin()) then
		return false -- only allow admins to talk in chat
	end
end

Parameters

• width

• height

Parameters

• client Player

  Player that has taken a shipment item

• uniqueID string

  UniqueID of the shipment item that was taken

• amount number

  Amount of the items that were taken

Parameters

• bar

Returns

• bool

  Whether or not the server should delete saved items

Example Usage

function PLUGIN:ShouldDeleteSavedItems()
 return true -- Delete all saved items.
end

Parameters

• newID

Parameters

• client

• weapon

Parameters

• item

Parameters

• client Player

  Player to permakill

• character Character

  Player's current character

• inflictor Entity

  Entity that inflicted the killing blow

• attacker Entity

  Other player or entity that killed the player

Returns

• bool

  false if the player should not be permakilled

Example Usage

function PLUGIN:ShouldPermakillCharacter(client, character, inflictor, attacker)
		if (client:IsAdmin()) then
			return false -- all non-admin players will have their character permakilled
		end
	end

Parameters

• client Player

  Player that is underwater

Returns

• bool

  Whether or not player should drown

Example Usage

function PLUGIN:ShouldPlayerDrowned(client)
 return false -- Players will not drown.
end

Parameters

• client Player

  Player that died

Returns

• bool

  Whether or not remove player ragdoll on death

Example Usage

function PLUGIN:ShouldRemoveRagdollOnDeath(client)
 return false -- Player ragdolls will not be removed.
end

Parameters

• characterID number

  ID of the character

• inventoryID number

  ID of the inventory

• inventoryType string

  Type of the inventory

Returns

• bool

  Whether or not to restore character inventory

Example Usage

function PLUGIN:ShouldRestoreInventory(characterID, inventoryID, inventoryType)
 return false -- Character inventories will not be restored.
end

Parameters

• client

Parameters

• client Player

  Player that died

Returns

• bool

  Whether or not spawn player ragdoll on death

Example Usage

function PLUGIN:ShouldSpawnClientRagdoll(client)
 return false -- Player ragdolls will not be spawned.
end

Parameters

• entity

Parameters

• oldValue

• value

Parameters

• panel

• character

Parameters

• panel

• character

Parameters

• newValue number

  New voice distance

Parameters

• weapon