This repository was archived by the owner on Apr 3, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathindex.html
More file actions
99 lines (93 loc) · 5.12 KB
/
index.html
File metadata and controls
99 lines (93 loc) · 5.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Psych Engine - Lua Script API</title>
<link rel="stylesheet" href="css/main.css">
<link rel="stylesheet" href="css/header.css">
<link rel="stylesheet" href="css/search.css">
<link rel="stylesheet" href="css/theme.css">
<link rel="icon" href="assets/icon.ico" type="image/x-icon">
</head>
<body>
<!-- Create Search Bar and Theme Boxes-->
<div class="sidebar"></div>
<div class="themeBox" onclick="switchTheme()">
<div class="themeDot"></div>
<div class="themeDot" style="margin-left: 70px"></div>
<button class="themeBtn" id="themeSelector"></button>
</div>
<!-- Load JavaScript-->
<script src="js/selector.js"></script>
<script>createSidebarContent('pages/');</script>
<script src="js/searchbar.js"></script>
<script src="js/theme.js"></script>
<!-- Header -->
<div class="headerbox">
<div class="header">
<a href="index.html">
<img width="64" src="assets/icon.ico" alt="Psych Engine Logo" draggable="false">
<div class="headertext">Psych Engine - Lua Script API</div>
</a>
</div>
</div>
<!-- Page Info -->
<div class="infobox">
<h1>Home Page</h1>
<hr>
<p>This site is highly inspired by Flixel API's site, so huge props to them.</p>
<p>These pages are intended for Psych Engine 1.0+, so it might not be reliable for older versions.
<br>Support for other versions has been abandoned and will not be added to these pages.
</p>
<img width="400" src="assets/logo.png" alt="Psych Engine Logo" class="logoImage" draggable="false">
<hr>
<h2>VS Code Extension</h2>
<p><a href="https://gamebanana.com/tools/10716">It's highly recommended for you to install it</a>, as it auto-completes function names.
</br>This is an unofficial tool though.</p>
<hr>
<h2>Running a script</h2>
<h3>There are 6 types of LUA Scripts you can run:</h3>
<ul class="methoddiv">
<li class="exampleitem"><b>Stage Script:</b> It will only run if the song's stage is loaded in the current chart, it should have the same name as your stage's .JSON file and should be inside <span class="methodexample">mods/My-Mod/stages/</span>.</li>
<li class="exampleitem"><b>Note Type Script:</b> It will only run if the named Note Type is being used in the current chart, it should be inside <span class="methodexample">mods/My-Mod/custom_notetypes/</span>.</li>
<li class="exampleitem"><b>Event Script:</b> It will only run if the said Event is being used on the chart, it should be located inside <span class="methodexample">mods/My-Mod/custom_events/</span>.</li>
<li class="exampleitem"><b>Song Script(s):</b> They should be saved inside the song's chart folder, it will only run in this specific song, no matter the Difficulty, Stage or anything else.</li>
<li class="exampleitem"><b>Character Script:</b> It will only be run if the specified character is used on the current Song. You can use variables <a href="pages/variables.html">dadName, boyfriendName and gfName</a> to check the current character used's name. (if dadName == 'pico' for example), should be in <span class="methodexample">mods/My-Mod/characters/</span>.</li>
<li class="exampleitem"><b>General Script:</b> It should be saved in <span class="methodexample">mods/My-Mod/scripts/</span>, it will always run in every Song as long as the Mod is loaded.</li>
</ul>
<hr>
<h2>Functions</h2>
<h3>There are 22 pages available with 212 functions:</h3>
<ul>
<li><a href="pages/playstate.html">PlayState Functions</a></li>
<li><a href="pages/reflection.html">Reflection Functions</a></li>
<li><a href="pages/spritesheet.html">Spritesheet Functions</a></li>
<li><a href="pages/flxanimate.html">FlxAnimate Functions</a></li>
<li><a href="pages/text.html">Text Functions</a></li>
<li><a href="pages/sound.html">Sound Functions</a></li>
<li><a href="pages/shaders.html">Shaders Functions</a></li>
<li><a href="pages/camera.html">Camera Functions</a></li>
<li><a href="pages/input.html">Input Functions</a></li>
<li><a href="pages/tween.html">Tween Functions</a></li>
<li><a href="pages/timer.html">Timer Functions</a></li>
<li><a href="pages/character.html">Character Functions</a></li>
<li><a href="pages/file.html">File I/O Functions</a></li>
<li><a href="pages/translations.html">Language/Translation Functions</a></li>
<li><a href="pages/achievements.html">Achievements Functions</a></li>
<li><a href="pages/substate.html">Substate Functions</a></li>
<li><a href="pages/precache.html">Precache Functions</a></li>
<li><a href="pages/score.html">Score Functions</a></li>
<li><a href="pages/savedata.html">Save Data Functions</a></li>
<li><a href="pages/script.html">Script Functions</a></li>
<li><a href="pages/discord.html">Discord Functions</a></li>
<li><a href="pages/uncategorized.html">Uncategorized Functions</a></li>
</ul>
<br><hr>
<h2>Other Pages</h2>
<ul>
<li><a href="pages/variables.html">List of all 106 Variables</a></li>
<li><a href="pages/snippets.html">Code Snippets</a></li>
</ul>
</div>
</body>
</html>