Skip to content

Commit 8cc5f99

Browse files
committed
docs(api): make it clear which method to use when registering custom input binds
1 parent 89ca0c4 commit 8cc5f99

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

src/main/java/dev/isxander/controlify/api/entrypoint/ControlifyEntrypoint.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,17 @@ public interface ControlifyEntrypoint {
1515
* Called once Controlify has initialised some systems but controllers
1616
* have not yet been discovered and constructed. This is the ideal
1717
* time to register events in preparation for controller discovery.
18+
* Input bindings cannot be registered here; use {@link #onControlifyPreInit} instead.
1819
*/
1920
void onControlifyInit(InitContext context);
2021

2122

2223
/**
2324
* Called at the end of Controlify's client-side entrypoint.
24-
* You can register guides here.
25+
* Use this to register guides, input bindings, radial icons, or screen processors,
26+
* and to subscribe to events from {@link dev.isxander.controlify.api.event.ControlifyEvents}.
27+
* Avoid referencing objects that are registered later (e.g. custom mod items),
28+
* as they may not be initialized yet and could cause errors due to deferred registration.
2529
*/
2630
void onControlifyPreInit(PreInitContext context);
2731

0 commit comments

Comments
 (0)