Item
Readonly
giftObtains the string which identifies the type of the gift.
When gifts has same shape but different colors, then giftType
will be different.
Please see Gift Data about relationship between giftType
values and actual gifts.
Readonly
idThe string representation of the ID that uniquely identifies a gift in the event. A gift with different id specifies a different gift, even when other properties including senderDisplayName and timestamp are same.
Readonly
initialObtains the initial position of the gift in global coordinates.
Initial position specifies where the gift appears in the space. The position is near the hand of the player who sent the gift.
When generating an item at this position, the item may collide with the gift and the gift effect may start at an unintended position. To avoid collision with the gift, do not attach a Collider to the item or set the layer of the generated item to VenueLayer0, VenueLayer1, VenueLayer2, etc.
Please see Layers about available layers in the world.
Readonly
initialObtains the initial rotation of the gift in global coordinates.
Initial rotation specifies the orientation of the gift when it appears in the space.
Readonly
initialObtains the initial velocity of the gift in global coordinates.
Initial velocity specifies the speed of the gift when it appears in the space.
The gift is not affected by the gravity set by PlayerHandle.setGravity and other methods, and moves in a parabolic trajectory with a constant downward acceleration.
Readonly
priceObtains the price of the gift as an integer value of Cluster Coin.
Readonly
senderThe player who has sent the gift.
The value will be null
when the player is a ghost or a group viewing participant.
It is possible that sender.exists()
is false
, when the player who sent the gift has already left the event.
Readonly
senderThe display name of the player who has sent the gift.
Unlike sender, this property returns valid name when the player is a ghost or a group viewing participant.
Readonly
timestampObtains the time when the gift was sent in UTC, in total milliseconds since Unix epoch.
Generated using TypeDoc
The gift sent in an event by a player. The value can be obtained by ClusterScript.onGiftSent.