--  LUA  GetPlayerFromStateBagName

0xA56135E0

-- GET_PLAYER_FROM_STATE_BAG_NAME
local retval --[[ integer ]] =
	GetPlayerFromStateBagName(
		bagName --[[ string ]]
	)

Parameters:

    bagName:

    An internal state bag ID from the argument to a state bag change handler.

Returns:

The player handle or 0 if the state bag name did not refer to a player, or the player does not exist.

On the server this will return the players source, on the client it will return the player handle.

Examples:

    JavaScript
    Lua

AddStateBagChangeHandler("isDead", nil, function(bagName, key, value) 

    local ply = GetPlayerFromStateBagName(bagName)

    -- The player doesn't exist!

    if ply == 0 then return end

    print("Player: " .. GetPlayerName(ply) .. value and 'died!' or 'is alive!')

end)
 
 

Parameters:

header:

sentence.

header:

sentence.

header:

sentence.

Returns:

sentence.

Summary

sentence.

Example

---  
    


Additional natives used in this example, or natives commonly used with this native.

NATIVE, NATIVE

Common Errors or Problems

Problem: sentence.

Problem: sentence.

Problem: sentence.

Credits and Disclaimers

The base of this data was taken from the redm/cfx fivem/rdr docs, and vespura. We have been saving and making notes for two years now, and are now adding them to our site for everyone to use. We will be modifying the notes as needed, and building tutorials around the data so these pages will change as we work on it. This is a manual process, not an automated one, so updates will occur as we have time, the priority is releasing resources. Thanks for your patience.

Was the documentation useful?

Related Examples and Posts