Interface Comment

The comment that can be obtained with ClusterScript.getLatestComments and ClusterScript.onCommentReceived.

Hierarchy

  • Comment

Properties

body displayName id sender timestamp via

Properties

body

body: string

The text of the comment.

displayName

displayName: string

The display name of the user who commented in Cluster or from YouTube.

id

id: string

A unique ID for each comment.

sender

sender: null | PlayerHandle

The PlayerHandle of the player who made the comment.

It returns null in the following cases.

  • If the comment is from YouTube
  • If the comment is from a ghost or group viewing

timestamp

timestamp: number

The time the comment was made. Returns the number of milliseconds that have elapsed since the UNIX epoch.

If via is “YouTube”, the timestamp of the comment will always have the last three digits as 000, and only the accuracy to the second is guaranteed.

via

via: "cluster" | "YouTube"

A string that indicates where the comment was made. Currently, it takes either the value “cluster” or “YouTube”. This may be added in a future update.

Settings

Member Visibility

Theme

Generated using TypeDoc