SetNPCPropertyValue: Difference between revisions
From Onset Developer Wiki
Created page with "{{Info|Function|Server & Client|1.0}} {{FuncDescription|Sets a property value for this entity. Useful to store information for individual entities which can be accessed on cl..." |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 10: | Line 10: | ||
{{FuncParam|PropertyName|Name of the property variable}} | {{FuncParam|PropertyName|Name of the property variable}} | ||
{{FuncParam|Value|Value can be a boolean, integer, float, string or table}} | {{FuncParam|Value|Value can be a boolean, integer, float, string or table}} | ||
{{FuncParamOptional|bSync|Enable automatic network sync for this property value.}} | {{FuncParamOptional|bSync|Enable automatic network sync for this property value. Default: '''true'''}} | ||
{{FuncReturnValue|Returns '''true''' on success.}} | {{FuncReturnValue|Returns '''true''' on success.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
-- client side example | |||
AddEvent("OnNPCStreamIn", function(npcid) | |||
local clothing_preset = GetNPCPropertyValue(npcid, "ClothingPreset") | |||
SetNPCClothingPreset(npcid, clothing_preset) | |||
end) | |||
-- server side example | |||
-- somewhere you create NPC and assign value | |||
local npcid = CreateNPC(x, y, z, h) | |||
SetNPCClothingPreset(npcid, "ClothingPreset", 2) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:NPCFunctions}} | |||
Latest revision as of 11:14, 1 September 2020
Description
Sets a property value for this entity. Useful to store information for individual entities which can be accessed on client and server and across different packages.
Syntax
SetNPCPropertyValue(npc, PropertyName, Value, bSync)
Client Syntax
SetNPCPropertyValue(npc, PropertyName, Value)
Parameters
- npc
The npc identifier - PropertyName
Name of the property variable - Value
Value can be a boolean, integer, float, string or table - bSync (optional)
Enable automatic network sync for this property value. Default: true
Return Value
- Returns true on success.
Example
-- client side example
AddEvent("OnNPCStreamIn", function(npcid)
local clothing_preset = GetNPCPropertyValue(npcid, "ClothingPreset")
SetNPCClothingPreset(npcid, clothing_preset)
end)
-- server side example
-- somewhere you create NPC and assign value
local npcid = CreateNPC(x, y, z, h)
SetNPCClothingPreset(npcid, "ClothingPreset", 2)
See also
- GetStreamedNPC
- GetNPCLocation
- SetNPCOutline
- SetNPCPropertyValue
- GetNPCPropertyValue
- CreateNPC
- DestroyNPC
- IsValidNPC
- GetAllNPC
- GetNPCCount
- IsNPCStreamedIn
- SetNPCLocation
- GetNPCLocation
- SetNPCHealth
- GetNPCHealth
- SetNPCAnimation
- SetNPCHeading
- GetNPCHeading
- SetNPCTargetLocation
- SetNPCFollowPlayer
- SetNPCFollowVehicle
- SetNPCRagdoll
- SetNPCRespawnTime
