Returns

• bool

  Whether or not the player can shoot their weapon

Parameters

• message string

  Text to display in the notification

Parameters

• message string

  ID of the phrase to display to the player

• ...

  Arguments to pass to the phrase

See Also

• NotifyLocalized

Parameters

• bDontSetPlayer boolean default: false

  Whether or not to avoid setting the ragdoll's owning player

Returns

• entity

  Created ragdoll entity

Parameters

• entity Entity

  that this player must look at

• callback function

  Function to call when the timer completes

• time number

  How much time in seconds this player must look at the entity for

• onCancel function default: nil

  Function to call when the timer has been cancelled

• distance number default: 96

  Maximum distance a player can move away from the entity before the action is cancelled

Example Usage

client:SetAction("Searching...", 4) -- for displaying the progress bar
client:DoStaredAction(entity, function()
	print("hello!")
end)
-- prints "hello!" after looking at the entity for 4 seconds

See Also

• SetAction

Parameters

• sequence string

  Name of the animation sequence to play

• callback function default: nil

  Function to call when the animation finishes. This is also called immediately if the animation fails to play

• time number default: nil

  How long to play the animation for. This defaults to the duration of the animation

• bNoFreeze boolean default: false

  Whether or not to avoid freezing this player in place while the animation is playing

See Also

• LeaveSequence

Returns

• Character

  Currently loaded character

OR
• nil

  If this player has no character loaded

Parameters

• entity Entity

  Entity to get a position for

Returns

• vector

  Best guess for a good drop position in front of the player

Example Usage

local position = client:GetItemDropPos(entity)
 entity:SetPos(position)

Parameters

• key string

  Identifier of the local variable

• default

  Default value to return if the local variable is not set

Returns

• any

  Value associated with the key, or the default that was given if it doesn't exist

Example Usage

print(client:GetLocalVar("secret"))
 > 12345678

See Also

• SetLocalVar

Returns

• string

  Name of this player's currently loaded character

OR
• string

  Steam name of this player if the player has no character loaded

Returns

• number

  Number of seconds the player has played on the server

Returns

• bool

  Whether or not the player has a female model

Returns

• bool

  Whether or not the player is restricted

Returns

• bool

  Whether or not the player is running

Returns

• bool

  Whether or not this player is stuck

Returns

• bool

  Whether or not the player has their weapon raised

Parameters

• message string

  Text to display in the notification

Parameters

• message string

  ID of the phrase to display to the player

• ...

  Arguments to pass to the phrase

Example Usage

client:NotifyLocalized("mapRestarting", 10)
 -- displays "The map will restart in 10 seconds!" if the player's language is set to English

See Also

• ix.lang

Parameters

• time number

  How much time in seconds this player has to hold use for

• entity Entity

  Entity that this player must be looking at

• callback function

  Function to run when the timer completes. It will be ran right away if time is 0. Returning false in the callback will not mark this interaction as dirty if you're managing the interaction state manually.

Parameters

• title string

  Title to display on the panel

• subTitle string

  Subtitle to display on the panel

• callback function

  Function to run when this player enters their input. Callback is ran with the user's input string.

• default string default: nil

  Default value to put in the text box.

Example Usage

client:RequestString("Hello", "Please enter your name", function(text)
	client:ChatPrint("Hello, " .. text)
end)
-- prints "Hello, " in the player's chat

Parameters

• text string

  Text to display above the progress bar

• time number default: 5

  How much time in seconds to wait before the timer completes

• callback function

  Function to run once the timer completes

• startTime number default: CurTime()

  Game time in seconds that the timer started. If you are using time, then you shouldn't use this argument

• finishTime number default: startTime + time

  Game time in seconds that the timer should complete at. If you are using time, then you shouldn't use this argument

Parameters

• key string

  Identifier of the local variable

• value

  New value to assign to the local variable

Example Usage

client:SetLocalVar("secret", 12345678)

See Also

• GetLocalVar

Parameters

• bState boolean

  Whether or not to ragdoll this player

• time number default: 0

  How long this player should stay ragdolled for. Set to 0 if they should stay ragdolled until they get back up manually

• getUpGrace number default: 5

  How much time in seconds to wait before the player is able to get back up manually. Set to the same number as time to disable getting up manually entirely

Parameters

• bState boolean

  Whether or not to restrict this player

• bNoMessage boolean

  Whether or not to suppress the restriction notification

Parameters

• bState boolean

  Whether or not the raise the weapon

• weapon Entity default: GetActiveWeapon()

  Weapon to raise or lower. You should pass this argument if you already have a reference to this player's current weapon to avoid an expensive lookup for this player's current weapon.