|
1 | | -# DateTimeFunctions-UnrealEnginePlugin |
2 | | - This is an Unreal Engine plugin that provides some functions related to Date and Time with a countdown functionality using event binding. |
3 | | -Packaged and tested on Unreal Engine 5.2 on windows only but in theory it can be compiled on any other version and for any other platform. |
4 | | - |
5 | | -To use it, just download it on your machine as zip file then extract to your project folder: YourProjectFolder -> Plugins (if this folder doesn't exist you can create it). |
6 | | - |
7 | | -Features: |
8 | | - |
9 | | -1- DateTime operations: Unix Timestamp, Subtract Dates (Result in seconds), Get time in a selected timezone. |
10 | | - |
11 | | -2- DateTime Formating: Format any date to a selected formt. Available formats are: DD/MM/YYYY | MM/DD/YYYY | Mon,DD YYYY | DD Mon YYYY | DD Month YYYY | YYYY-MM-DD |
12 | | - |
13 | | -3- Countdown functionality: Input in seconds, an event can be binded and called on every second to update the seconds. Countdown usage example: |
14 | | - |
15 | | - |
16 | | -All available functions: |
17 | | - |
18 | | -Unix Timestamp: returns the seconds since 01/01/1970. |
19 | | - |
20 | | -Subtract Dates: returns the seconds of 2 Dates subtraction. |
21 | | - |
22 | | -Get Date Time in selected timezone: returns the date and time of the selected timezone. |
23 | | - |
24 | | -Format Date: change the formatting of a Date to the selected format available from a list. |
25 | | - |
26 | | -Format Seconds: returns the seconds passed in a selected format (HH:MM:SS | HH:MM | MM:SS). |
27 | | - |
28 | | -Hours To Seconds: returns the number of seconds in the entered hours number (accept float: 1.5 hour returns 5400). |
29 | | - |
30 | | -Get Month Short Name: returns the short name of a month in English based on its number (1 returns Jan). |
31 | | - |
32 | | -Get Month Full Name: returns the name of the month in English based on its number (1 returns January). |
| 1 | +# DateTimeFunctions Unreal Engine Plugin |
| 2 | + |
| 3 | +This Unreal Engine plugin provides various functions related to Date and Time, including countdown functionality using event binding. |
| 4 | + |
| 5 | +Packaged and tested on **Unreal Engine 5.2** for **Windows**, but it can theoretically be compiled on other versions and platforms. |
| 6 | + |
| 7 | +## Installation |
| 8 | +1. Download the plugin as a ZIP file. |
| 9 | +2. Extract the ZIP to your project folder under the following path: |
| 10 | + - `YourProjectFolder/Plugins` |
| 11 | + - *(If the `Plugins` folder doesn’t exist, create it.)* |
| 12 | + |
| 13 | +## Features |
| 14 | + |
| 15 | +### DateTime Operations |
| 16 | +- **Unix Timestamp**: Returns the seconds elapsed since 01/01/1970. |
| 17 | +- **Subtract Dates**: Calculates the difference between two dates in seconds. |
| 18 | +- **Get DateTime in a Selected Timezone**: Returns the date and time of the selected timezone. |
| 19 | + |
| 20 | +### DateTime Formatting |
| 21 | +- **Format Date**: Formats any date to one of the following options: |
| 22 | + - `DD/MM/YYYY` |
| 23 | + - `MM/DD/YYYY` |
| 24 | + - `Mon, DD YYYY` |
| 25 | + - `DD Mon YYYY` |
| 26 | + - `DD Month YYYY` |
| 27 | + - `YYYY-MM-DD` |
| 28 | +- **Format Seconds**: Converts seconds into a selected time format: |
| 29 | + - `HH:MM:SS` |
| 30 | + - `HH:MM` |
| 31 | + - `MM:SS` |
| 32 | + |
| 33 | +### Countdown Functionality |
| 34 | +- **Countdown Timer**: Accepts input in seconds. |
| 35 | + - An event can be bound and triggered every second to update the remaining time. |
| 36 | + |
| 37 | +#### Countdown Usage Example: |
| 38 | + |
| 39 | + |
| 40 | +## Available Functions |
| 41 | + |
| 42 | +### General Date and Time Functions |
| 43 | +1. **Unix Timestamp**: Returns the seconds since 01/01/1970. |
| 44 | +2. **Subtract Dates**: Returns the difference between two dates in seconds. |
| 45 | +3. **Get DateTime in Selected Timezone**: Returns the date and time in the specified timezone. |
| 46 | + |
| 47 | +### Formatting Functions |
| 48 | +4. **Format Date**: Formats a date to the desired format (listed above). |
| 49 | +5. **Format Seconds**: Formats seconds into `HH:MM:SS`, `HH:MM`, or `MM:SS`. |
| 50 | + |
| 51 | +### Utility Functions |
| 52 | +6. **Hours to Seconds**: Converts a number of hours (accepts floats) to seconds. |
| 53 | + - Example: `1.5 hours` → `5400 seconds` |
| 54 | +7. **Get Month Short Name**: Returns the short name of a month (e.g., `1` → `Jan`). |
| 55 | +8. **Get Month Full Name**: Returns the full name of a month (e.g., `1` → `January`). |
0 commit comments