CommonEntryPoint (api 0.4.6 API)

java.lang.Object
- mods.thecomputerizer.theimpossiblelibrary.api.common.CommonEntryPoint

All Implemented Interfaces:

CoreStateAccessor

Direct Known Subclasses:

ClientEntryPoint, DelegatingCommonEntryPoint
```
public abstract class CommonEntryPoint
extends java.lang.Object
implements CoreStateAccessor
```
Common entrypoint API Handle run order: this, client, server, custom It is highly recommended to define delegate handlers statically to avoid any duplicates in the entrypoint chain.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClientEntryPoint`	`delegatedClientHandle`
`protected CommonEntryPoint`	`delegatedCustomHandle`
`protected CommonEntryPoint`	`delegatedServerHandle`
`protected java.lang.Object`	`extraData`
`protected CommonEntryPoint`	`parent`

Fields inherited from interface mods.thecomputerizer.theimpossiblelibrary.api.core.CoreStateAccessor
BOOLEAN_VALUES, FABRIC, FORGE, FORGE_OR_NEOFORGE, GAME_VERSION, JAVA_17, JAVA_21, JAVA_8, JAVA_MODULES, JAVA_VERSION, JAVA_VERSION_ASM, LEGACY, MOD_LOADER, NAMED_ENV, NEOFORGE, SRG_ENV, V12, V16, V16_OR_EARLIER, V16_OR_LATER, V18, V18_OR_EARLIER, V18_OR_LATER, V19, V19_2_OR_EARLIER, V19_4_OR_LATER, V19_OR_EARLIER, V19_OR_LATER, V20, V20_4_OR_EARLIER, V20_6_OR_LATER, V20_OR_EARLIER, V20_OR_LATER, V21, V21_OR_LATER

Constructor Summary

Constructors
Modifier Constructor and Description

protected CommonEntryPoint()

protected CommonEntryPoint(boolean root)

Constructors
Modifier	Constructor and Description
`protected`	`CommonEntryPoint()`
`protected`	`CommonEntryPoint(boolean root)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkClientSetup()`
`protected void`	`checkClientSetupInner()` Runs after CoreAPI#isClient is verified
`void`	`checkDedicatedServerSetup()`
`protected void`	`checkDedicatedServerSetupInner()` Runs after CoreAPI#isServer is verified
`protected abstract java.lang.String`	`getModID()`
`protected abstract java.lang.String`	`getModName()`
`protected void`	`handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle)` Handles a CommonEntryPoint method on this and all known handles other than this.
`protected void`	`handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle, boolean ignoreThis)` Handles a CommonEntryPoint method on this and all known handles.
`protected void`	`handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle, java.util.function.Consumer<ClientEntryPoint> clientHandle)` Handles a CommonEntryPoint method on this and all known handles other than this via the commonHandle input.
`protected void`	`handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle, java.util.function.Consumer<ClientEntryPoint> clientHandle, boolean ignoreThis)` Handles a CommonEntryPoint method on this and all known handles via the commonHandle input.
`protected void`	`handleEither(@Nullable CommonEntryPoint delegate, java.util.function.Consumer<CommonEntryPoint> commonHandle, java.util.function.Consumer<ClientEntryPoint> clientHandle)` Handles either a CommonEntryPoint or ClientEntryPoint method on the input delegate, depending on whether it is an instance of ClientEntryPoint.
`protected void`	`handleWithClient(java.util.function.Consumer<ClientEntryPoint> clientHandle)` Handles a ClientEntryPoint method on the delegatedClientHandle if it exists.
`protected void`	`handleWithClient(java.util.function.Consumer<ClientEntryPoint> clientHandle, boolean strict)` Handles a ClientEntryPoint method on only this object if is an isntance of ClientEntryPoint and the delegatedClientHandle if it exists.
`protected void`	`handleWithClientCustom(java.util.function.Consumer<ClientEntryPoint> clientHandle)` Handles a ClientEntryPoint method on the delegatedClientHandle if it exists and the delegatedCustomHandle if it exists and is an instance of ClientEntryPoint.
`protected void`	`handleWithClientCustom(java.util.function.Consumer<ClientEntryPoint> clientHandle, boolean strict)` Handles a ClientEntryPoint method on only this object, the delegatedClientHandle if it exists, and the delegatedCustomHandle if it exists and is an instance of ClientEntryPoint.
`protected void`	`handleWithCustom(java.util.function.Consumer<CommonEntryPoint> customHandle)` Handles a CommonEntryPoint method on only this object and the delegatedCustomHandle if it exists.
`protected void`	`handleWithCustom(java.util.function.Consumer<CommonEntryPoint> customHandle, boolean strict)` Handles a CommonEntryPoint method on only this object and the delegatedCustomHandle if it exists.
`protected void`	`handleWithServer(java.util.function.Consumer<CommonEntryPoint> serverHandle)` Handles a CommonEntryPoint method on the delegatedServerHandle if it exists.
`protected void`	`handleWithServer(java.util.function.Consumer<CommonEntryPoint> serverHandle, boolean strict)` Handles a CommonEntryPoint method on only this object and the delegatedServerHandle if it exists.
`protected void`	`handleWithServerCustom(java.util.function.Consumer<CommonEntryPoint> serverHandle)` Handles a CommonEntryPoint method on the delegatedServerHandle if it exists and the delegatedCustomHandle if it exists.
`protected void`	`handleWithServerCustom(java.util.function.Consumer<CommonEntryPoint> serverHandle, boolean strict)` Handles a CommonEntryPoint method on only this object, the delegatedServerHandle if it exists, and the delegatedCustomHandle if it exists.
`void`	`onCommonSetup()`
`void`	`onConstructed()`
`protected void`	`onDedicatedServerSetup()`
`protected void`	`onHandleAdded(CommonEntryPoint handle)`
`void`	`onInterModEnqueue()`
`void`	`onInterModProcess()`
`void`	`onLoadComplete()`
`void`	`onPreRegistration()`
`void`	`onServerAboutToStart()`
`void`	`onServerStarted()`
`void`	`onServerStarting()`
`void`	`onServerStopped()`
`void`	`onServerStopping()`
`@Nullable ClientEntryPoint`	`setDelegatedClientHandle()` Defines a delegate for handling client stuff specific to ClientEntryPoint
`@Nullable CommonEntryPoint`	`setDelegatedCustomHandle()` Defines a delegate for handling a custom extension of CommonEntryPoint.
`@Nullable CommonEntryPoint`	`setDelegatedServerHandle()` Defines a delegate for handling CommonEntryPoint stuff that only runs on servers
`void`	`setExtraData(java.lang.Object data)` Called via ASM or a parent delegator
`protected boolean`	`verifyNoDuplicates(@Nullable CommonEntryPoint handler)` Extra guardrail against the same handler trying to get defined more than once in an entrypoint chain.
`protected boolean`	`verifyNoDuplicatesInner(CommonEntryPoint handler)` Assumes all the parents are null or have all been checked and that the handler is not null

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - delegatedClientHandle
```
protected final ClientEntryPoint delegatedClientHandle
```
  - delegatedCustomHandle
```
protected final CommonEntryPoint delegatedCustomHandle
```
  - delegatedServerHandle
```
protected final CommonEntryPoint delegatedServerHandle
```
  - parent
```
protected CommonEntryPoint parent
```
  - extraData
```
protected java.lang.Object extraData
```
- Constructor Detail
  - CommonEntryPoint
```
protected CommonEntryPoint()
```
  - CommonEntryPoint
```
protected CommonEntryPoint(boolean root)
```
- Method Detail
  - onHandleAdded
```
protected final void onHandleAdded(CommonEntryPoint handle)
```
  - checkClientSetup
```
public final void checkClientSetup()
```
  - checkClientSetupInner
```
protected final void checkClientSetupInner()
```
    Runs after CoreAPI#isClient is verified
  - checkDedicatedServerSetup
```
public final void checkDedicatedServerSetup()
```
  - checkDedicatedServerSetupInner
```
protected final void checkDedicatedServerSetupInner()
```
    Runs after CoreAPI#isServer is verified
  - getModID
```
protected abstract java.lang.String getModID()
```
  - getModName
```
protected abstract java.lang.String getModName()
```
  - handleAll
```
protected final void handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle,
                               java.util.function.Consumer<ClientEntryPoint> clientHandle)
```
    Handles a CommonEntryPoint method on this and all known handles other than this via the commonHandle input. Each ClientEntryPoint handle will instead be handled via the clientHandle input.
  - handleAll
```
protected final void handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle,
                               java.util.function.Consumer<ClientEntryPoint> clientHandle,
                               boolean ignoreThis)
```
    Handles a CommonEntryPoint method on this and all known handles via the commonHandle input. Each ClientEntryPoint handle (including this object) will instead be handled via the clientHandle input. If ignoreThis is enabled, all handles other than this will be run (the typical desired use case).
  - handleAll
```
protected final void handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle)
```
    Handles a CommonEntryPoint method on this and all known handles other than this.
  - handleAll
```
protected final void handleAll(java.util.function.Consumer<CommonEntryPoint> commonHandle,
                               boolean ignoreThis)
```
    Handles a CommonEntryPoint method on this and all known handles. If ignoreThis is enabled, all handles other than this will be run (the typical desired use case).
  - handleEither
```
protected final void handleEither(@Nullable
                                  @Nullable CommonEntryPoint delegate,
                                  java.util.function.Consumer<CommonEntryPoint> commonHandle,
                                  java.util.function.Consumer<ClientEntryPoint> clientHandle)
```
    Handles either a CommonEntryPoint or ClientEntryPoint method on the input delegate, depending on whether it is an instance of ClientEntryPoint.
  - handleWithClient
```
protected final void handleWithClient(java.util.function.Consumer<ClientEntryPoint> clientHandle)
```
    Handles a ClientEntryPoint method on the delegatedClientHandle if it exists.
  - handleWithClient
```
protected final void handleWithClient(java.util.function.Consumer<ClientEntryPoint> clientHandle,
                                      boolean strict)
```
    Handles a ClientEntryPoint method on only this object if is an isntance of ClientEntryPoint and the delegatedClientHandle if it exists. If strict is enabled, only the delegatedClientHandle is run.
  - handleWithClientCustom
```
protected final void handleWithClientCustom(java.util.function.Consumer<ClientEntryPoint> clientHandle)
```
    Handles a ClientEntryPoint method on the delegatedClientHandle if it exists and the delegatedCustomHandle if it exists and is an instance of ClientEntryPoint.
  - handleWithClientCustom
```
protected final void handleWithClientCustom(java.util.function.Consumer<ClientEntryPoint> clientHandle,
                                            boolean strict)
```
    Handles a ClientEntryPoint method on only this object, the delegatedClientHandle if it exists, and the delegatedCustomHandle if it exists and is an instance of ClientEntryPoint. If strict is enabled, only the delegatedClientHandle and delegatedCustomHandle are run.
  - handleWithCustom
```
protected final void handleWithCustom(java.util.function.Consumer<CommonEntryPoint> customHandle)
```
    Handles a CommonEntryPoint method on only this object and the delegatedCustomHandle if it exists.
  - handleWithCustom
```
protected final void handleWithCustom(java.util.function.Consumer<CommonEntryPoint> customHandle,
                                      boolean strict)
```
    Handles a CommonEntryPoint method on only this object and the delegatedCustomHandle if it exists. If strict is enabled, only the delegatedCustomHandle is run.
  - handleWithServer
```
protected final void handleWithServer(java.util.function.Consumer<CommonEntryPoint> serverHandle)
```
    Handles a CommonEntryPoint method on the delegatedServerHandle if it exists.
  - handleWithServer
```
protected final void handleWithServer(java.util.function.Consumer<CommonEntryPoint> serverHandle,
                                      boolean strict)
```
    Handles a CommonEntryPoint method on only this object and the delegatedServerHandle if it exists. If strict is enabled, only the delegatedServerHandle is run
  - handleWithServerCustom
```
protected final void handleWithServerCustom(java.util.function.Consumer<CommonEntryPoint> serverHandle)
```
    Handles a CommonEntryPoint method on the delegatedServerHandle if it exists and the delegatedCustomHandle if it exists.
  - handleWithServerCustom
```
protected final void handleWithServerCustom(java.util.function.Consumer<CommonEntryPoint> serverHandle,
                                            boolean strict)
```
    Handles a CommonEntryPoint method on only this object, the delegatedServerHandle if it exists, and the delegatedCustomHandle if it exists. If strict is enabled, only the delegatedServerHandle and delegatedCustomHandle are run.
  - onConstructed
```
public void onConstructed()
```
  - onPreRegistration
```
public void onPreRegistration()
```
  - onCommonSetup
```
public void onCommonSetup()
```
  - onDedicatedServerSetup
```
protected void onDedicatedServerSetup()
```
  - onInterModEnqueue
```
public void onInterModEnqueue()
```
  - onInterModProcess
```
public void onInterModProcess()
```
  - onLoadComplete
```
public void onLoadComplete()
```
  - onServerAboutToStart
```
public void onServerAboutToStart()
```
  - onServerStarting
```
public void onServerStarting()
```
  - onServerStarted
```
public void onServerStarted()
```
  - onServerStopping
```
public void onServerStopping()
```
  - onServerStopped
```
public void onServerStopped()
```
  - setDelegatedClientHandle
```
@Nullable
public @Nullable ClientEntryPoint setDelegatedClientHandle()
```
    Defines a delegate for handling client stuff specific to ClientEntryPoint
  - setDelegatedCustomHandle
```
@Nullable
public @Nullable CommonEntryPoint setDelegatedCustomHandle()
```
    Defines a delegate for handling a custom extension of CommonEntryPoint. Used internally to handle some version-specific stuff
  - setDelegatedServerHandle
```
@Nullable
public @Nullable CommonEntryPoint setDelegatedServerHandle()
```
    Defines a delegate for handling CommonEntryPoint stuff that only runs on servers
  - setExtraData
```
public void setExtraData(java.lang.Object data)
```
    Called via ASM or a parent delegator
  - verifyNoDuplicates
```
protected boolean verifyNoDuplicates(@Nullable
                                     @Nullable CommonEntryPoint handler)
```
    Extra guardrail against the same handler trying to get defined more than once in an entrypoint chain. This won't guard against the same handler type being instantiated multiple times, so be careful.
  - verifyNoDuplicatesInner
```
protected boolean verifyNoDuplicatesInner(CommonEntryPoint handler)
```
    Assumes all the parents are null or have all been checked and that the handler is not null

Class CommonEntryPoint

Field Summary

Fields inherited from interface mods.thecomputerizer.theimpossiblelibrary.api.core.CoreStateAccessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

delegatedClientHandle

delegatedCustomHandle

delegatedServerHandle

parent

extraData

Constructor Detail

CommonEntryPoint

CommonEntryPoint

Method Detail

onHandleAdded

checkClientSetup

checkClientSetupInner

checkDedicatedServerSetup

checkDedicatedServerSetupInner

getModID

getModName

handleAll

handleAll

handleAll

handleAll

handleEither

handleWithClient

handleWithClient

handleWithClientCustom

handleWithClientCustom

handleWithCustom

handleWithCustom

handleWithServer

handleWithServer

handleWithServerCustom

handleWithServerCustom

onConstructed

onPreRegistration

onCommonSetup

onDedicatedServerSetup

onInterModEnqueue

onInterModProcess

onLoadComplete

onServerAboutToStart

onServerStarting

onServerStarted

onServerStopping

onServerStopped

setDelegatedClientHandle

setDelegatedCustomHandle

setDelegatedServerHandle

setExtraData

verifyNoDuplicates

verifyNoDuplicatesInner