What is @Instance?

[leonardude]

Hey all!

 

I was watching a tutorial and I saw this thing that was like:

 

@Instance(modid)

public static ModClass instance;

 

And I don't know what Instance is used for!

Please help and thanks in advance!

 

Leonardude

[Draco18s]

That's how Forge / ModLoader knows how to find your mod and access it.

[leonardude]

Do you use the variable instance for anything or is the only thing that you put:

 

@Instance(modid)

public static ModClass instance;

[Draco18s]

Nope, just leave it like that.  You can reference it if you want to, but you don't need to set it or do anything else.

[leonardude]

What would I do to reference it and what would I reference it for?

[Draco18s]

What would I do to reference it and what would I reference it for?

 

If you don't know, then leave it alone.  It has to be there for your mod to load correctly, but if that's all you do with it, then that's fine.

[TLHPoE]

I'm almost 100% sure that if you want to use GUIs, then you'll need the Instance annotation.

[Mazetar]

Sometimes you pass an instance of your @mod to things like the player.openGui call.

 

If you have non static members then the instance is the way to access them.

[Romejanic]

If you are dive;oping a basic mod, you probably don't need it, but if you have any public objects in your class, it is 100% necessary.

 

For example:

 

public static Item myItem; // this will NOT require the instance, you access it like: MyMod.myItem

 

public boolean updateAvaliable = false; // this WILL require the instance, you access it like: MyMod.instance.updateAvaliable

 

Hope this helped!