Skip to content
This repository has been archived by the owner on May 8, 2024. It is now read-only.

Commit

Permalink
Update userdata docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ZyeByte committed May 13, 2023
1 parent eb2450d commit d093ea8
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/types/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ class Event {
description: string;
startsAt: uint;
endsAt: uint;
userdata1: string;
userdata2: string;
}
```

Expand All @@ -19,6 +21,8 @@ class Event {
- `description` (type: `string`): Represents a description or additional information about the event.
- `startsAt` (type: `uint`): Represents the start time of the event. It is stored as a 32-bit Unix timestamp, indicating the number of seconds since January 1, 1970, 00:00:00 UTC.
- `endsAt` (type: `uint`): Represents the end time of the event. It is also stored as a 32-bit Unix timestamp.
- `userdata1` (type: `string`): Represents a custom user-set string value.
- `userdata2` (type: `string`): Represents a custom user-set string value.

## Example Usage

Expand All @@ -37,3 +41,4 @@ In this example, an `Event` object is created and initialized with a name, descr

- The start and end times of the event are represented as 32-bit Unix timestamps. These timestamps are commonly used to store and manipulate date and time information.
- The `startsAt` and `endsAt` properties can be converted to human-readable date and time strings using the `formatTime` function.
- `userdata1` and `userdata2` are set while creating events.

0 comments on commit d093ea8

Please sign in to comment.