Skip to content

Commit 490524f

Browse files
committed
2 parents efccf43 + fabf20f commit 490524f

File tree

1 file changed

+12
-46
lines changed

1 file changed

+12
-46
lines changed

README.md

Lines changed: 12 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,19 @@
11
# ScriptBloxAPI
2-
### GetScriptFromScriptbloxId
32

4-
Retrieves a script from Scriptblox based on the provided Scriptblox ID.
3+
![C#](https://img.shields.io/badge/c%23-%23239120.svg?style=for-the-badge&logo=c-sharp&logoColor=white) ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white) [![Support Server](https://img.shields.io/discord/477201632204161025.svg?label=Discord&logo=Discord&colorB=7289da&style=for-t-he-badge)](https://discord.gg/7mJaZC5) ![GitHub](https://img.shields.io/github/license/IrisV3rm/iOverlay?style=for-the-badge) ![GitHub all releases](https://img.shields.io/github/downloads/IrisV3rm/ScriptBloxAPI/total?style=for-the-badge)
54

6-
**Parameters:**
7-
- `bloxId` (string): The Scriptblox ID of the script to retrieve.
5+
## Features
6+
- GetScriptFromScriptbloxId\n
7+
- GetFrontPageScripts
8+
- GetScriptsFromPageNumber
9+
- GetScriptsFromQuery
10+
- GetScriptsFromUser
811

9-
**Returns:**
10-
- `Script`: The script retrieved from the API, or a default script if the retrieval fails or the data is invalid.
12+
- GetUserFromUsername
13+
- GetUserFromUsername
1114

12-
### GetFrontPageScripts
15+
## License
1316

14-
Retrieves a list of scripts from the front page based on the provided page number.
17+
[GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/)
1518

16-
**Parameters:**
17-
- `pageNumber` (int, optional): The page number of the front page scripts (default is 1).
18-
19-
**Returns:**
20-
- `List<Script>`: A list of Script objects representing the scripts from the front page.
21-
22-
### GetScriptsFromPageNumber
23-
24-
Retrieves a list of scripts from the front page based on the provided page number.
25-
26-
**Parameters:**
27-
- `pageNumber` (int, optional): The page number of the front page scripts (default is 1).
28-
29-
**Returns:**
30-
- `List<Script>`: A list of Script objects representing the scripts from the front page.
31-
32-
### GetScriptsFromQuery
33-
34-
Retrieves a list of scripts from Scriptblox based on the provided search query and maximum results.
35-
36-
**Parameters:**
37-
- `searchQuery` (string): The search query to filter the scripts.
38-
- `maxResults` (int, optional): The maximum number of results to retrieve (default is 20).
39-
40-
**Returns:**
41-
- `List<Script>`: A list of Script objects representing the scripts matching the search query.
42-
43-
### GetScriptsFromUser
44-
45-
Retrieves a list of scripts from Scriptblox based on the provided username.
46-
47-
**Parameters:**
48-
- `username` (string): The username of the user whose scripts to retrieve.
49-
50-
**Returns:**
51-
- `List<Script>`: A list of Script objects representing the scripts owned by the user.
52-
53-
Note: The `GetScriptsFromPageNumber` function is an alias for `GetFrontPageScripts` and behaves the same way.
19+
Documentation: https://api.irisapp.ca/Docs/ScriptBloxAPI/

0 commit comments

Comments
 (0)