Feather core sends a server and client event as soon as the player is loaded/spawned into the world.
Event: Feather:Character:Spawned
Example Usage:
Feather FrameworkRegisterNetEvent("Feather:Character:Spawned", function(character)
-- character param is the character object (x, y, z, etc)
-- Do something here now that the character is spawned
end)RegisterNetEvent("Feather:Character:Spawned", function(character)
-- character param is the character object (x, y, z, etc)
-- Do something here now that the character is spawned
end)Create a character in DB
| Parameter | Description |
|---|---|
| userid | the numerical id of the User |
| roldid | the numerical id of the role assigned to the user |
| firstname | the string value for firstname |
| lastname | the string value for lastname |
| dob | string in format mm-dd-yyyy |
| dollars | float value for money |
| gold | float value |
| tokens | float value |
| xp | float value |
| x | float value for position x |
| y | float value for position y |
| z | float value for position z |
| lang | string value of the active language for user |
FeatherCore.Character.CreateCharacter(userid, roldid, firstname, lastname, dob, dollars, gold, tokens, xp, x, y, z, lang)
Example Usage:
CharacterAPI.CreateCharacter(1, 1, 'Test', 'Mcgee', '10-10-1941', 0, 0, 0, 0, 0, 0, 0, "en_us")CharacterAPI.CreateCharacter(1, 1, 'Test', 'Mcgee', '10-10-1941', 0, 0, 0, 0, 0, 0, 0, "en_us")| Parameter | Description |
|---|---|
| src | the source to initiate/spawn the character on |
| charid | int representation of the character id |
FeatherCore.Character.InitiateCharacter(src, 1)
Example Usage:
FeatherCore.Character.InitiateCharacter(src, 1)FeatherCore.Character.InitiateCharacter(src, 1)FeatherCore.Character.GetAvailableCharactersFromDB(src)FeatherCore.Character.GetAvailableCharactersFromDB(src)or
FeatherCore.Character.GetAllCharacters(src)FeatherCore.Character.GetAllCharacters(src)FeatherCore.Character.GetCharacter({ src = src })FeatherCore.Character.GetCharacter({ src = src })FeatherCore.Character.GetCharacterByID({ id = charid })FeatherCore.Character.GetCharacterByID({ id = charid })local player = FeatherCore.Character.GetCharacter({ src = src })
player:RemoveCharacter()local player = FeatherCore.Character.GetCharacter({ src = src })
player:RemoveCharacter()local player = FeatherCore.Character.GetCharacterByID({ id = charid })
local character = player.char
print(character.xp)local player = FeatherCore.Character.GetCharacterByID({ id = charid })
local character = player.char
print(character.xp)| Parameter | Description |
|---|---|
| key | the key to change in the cache/db |
| value | the value to update the key with |
player:UpdateAttribute(key, val)
Example Usage:
local player = FeatherCore.Character.GetCharacter({ src = src })
player:UpdateAttribute('lang', 'en_us')local player = FeatherCore.Character.GetCharacter({ src = src })
player:UpdateAttribute('lang', 'en_us')| Parameter | Description |
|---|---|
| key | the key to change (dollars, gold, xp, tokens) |
| amount | float/int, how much to add |
player:Add(key, amount)
Example Usage:
local player = FeatherCore.Character.GetCharacter({ src = src })
player:Add('dollars', 10)local player = FeatherCore.Character.GetCharacter({ src = src })
player:Add('dollars', 10)| Parameter | Description |
|---|---|
| key | the key to change (dollars, gold, xp, tokens) |
| amount | float/int, how much to subtract |
player:Subtract(src, key, amount)
Example Usage:
local player = FeatherCore.Character.GetCharacter({ src = src })
player:Subtract('dollars', 5)local player = FeatherCore.Character.GetCharacter({ src = src })
player:Subtract('dollars', 5)local player = FeatherCore.Character.GetCharacter({ src = src })
player:Logout()local player = FeatherCore.Character.GetCharacter({ src = src })
player:Logout()