GetPickupPropertyValue

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GetPickupPropertyValue

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Gets a property value for this entity.

Syntax

GetPickupPropertyValue(pickup, PropertyName)

Parameters

  • pickup
    The pickup identifier
  • PropertyName
    Name of the property variable

Return Value

  • Returns the value.

Example

Server

function OnPackageStart()
	local pickup = CreatePickup(1, 0.0, 0.0, 0.0)
	SetPickupPropertyValue(pickup, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)

Client

AddEvent("OnPickupStreamIn", function(pickup)
	AddPlayerChat("P: "..GetPickupPropertyValue(pickup, "testValue"))
end)

See also