Class StructureLibAPI
- java.lang.Object
-
- com.gtnewhorizon.structurelib.StructureLibAPI
-
public class StructureLibAPI extends java.lang.ObjectA stable interface into the structure lib's internals. Backwards compatibility is maintained to the maximum extend possible.
-
-
Field Summary
Fields Modifier and Type Field Description static intHINT_BLOCK_META_AIRstatic intHINT_BLOCK_META_DEFAULTstatic intHINT_BLOCK_META_ERRORstatic intHINT_BLOCK_META_GENERIC_0static intHINT_BLOCK_META_GENERIC_1static intHINT_BLOCK_META_GENERIC_10static intHINT_BLOCK_META_GENERIC_11static intHINT_BLOCK_META_GENERIC_2static intHINT_BLOCK_META_GENERIC_3static intHINT_BLOCK_META_GENERIC_4static intHINT_BLOCK_META_GENERIC_5static intHINT_BLOCK_META_GENERIC_6static intHINT_BLOCK_META_GENERIC_7static intHINT_BLOCK_META_GENERIC_8static intHINT_BLOCK_META_GENERIC_9static intHINT_BLOCK_META_NOT_AIRstatic java.lang.StringMOD_ID
-
Constructor Summary
Constructors Constructor Description StructureLibAPI()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static voidaddThrottledChat(java.lang.Object throttleKey, EntityPlayer player, IChatComponent text, short intervalRequired)Send chat to player, but throttled.static voidaddThrottledChat(java.lang.Object throttleKey, EntityPlayer player, IChatComponent text, short intervalRequired, boolean forceUpdateLastSend)Send chat to player, but throttled.static voiddisableInstrument()Stop instrumenting.static voidenableInstrument(java.lang.Object identifier)Start instrumenting for the current thread only.static voidendHinting(World w)End current batch of hinting.static BlockgetBlockHint()Get the Block for StructureLib supplied hint block.static ItemgetDefaultHologramItem()Get the hologram item.static ItemgetItemBlockHint()Get the ItemBlock for StructureLib supplied hint block.static voidhintParticle(World w, int x, int y, int z, Block block, int meta)Generate a new hint particle on client side at given location using textures from given block.static voidhintParticle(World w, int x, int y, int z, IIcon[] icons)Generate a new hint particle on client side at given location using given textures.static voidhintParticleTinted(World w, int x, int y, int z, Block block, int meta, short[] RGBa)Generate a new hint particle on client side at given location using textures from given block with a tint.static voidhintParticleTinted(World w, int x, int y, int z, IIcon[] icons, short[] RGBa)Generate a new hint particle on client side at given location using given textures with a tint.static booleanisBlockTriviallyReplaceable(World w, int x, int y, int z, EntityPlayer actor)Determines if given block can be replaced without much effort.static booleanisBlockTriviallyReplaceable(World w, int x, int y, int z, EntityPlayerMP actor)Deprecated.static booleanisDebugEnabled()Check if structure debug mode is on.static booleanisInstrumentEnabled()Check if instrumenting is enabled.static booleanmarkHintParticleError(EntityPlayer player, World w, int x, int y, int z)Update the tint of given hint particle.static voidqueryAlignment(IAlignmentProvider provider)Query the ExtendedFacing of this tile entity from client side.static voidsendAlignment(IAlignmentProvider provider)Send the ExtendedFacing of this Tile Entity to all players.static voidsendAlignment(IAlignmentProvider provider, NetworkRegistry.TargetPoint targetPoint)Send the ExtendedFacing of this Tile Entity to all players around target point.static voidsendAlignment(IAlignmentProvider provider, EntityPlayerMP player)Send the ExtendedFacing of this Tile Entity to given player.static voidsendAlignment(IAlignmentProvider provider, World dimension)Send the ExtendedFacing of this Tile Entity to all players in that dimension.static voidsetDebugEnabled(boolean enabled)static voidstartHinting(World w)Start a batch of hinting.static booleanupdateHintParticleTint(EntityPlayer player, World w, int x, int y, int z, short[] RGBa)Update the tint of given hint particle.
-
-
-
Field Detail
-
MOD_ID
public static final java.lang.String MOD_ID
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_0
public static final int HINT_BLOCK_META_GENERIC_0
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_1
public static final int HINT_BLOCK_META_GENERIC_1
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_2
public static final int HINT_BLOCK_META_GENERIC_2
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_3
public static final int HINT_BLOCK_META_GENERIC_3
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_4
public static final int HINT_BLOCK_META_GENERIC_4
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_5
public static final int HINT_BLOCK_META_GENERIC_5
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_6
public static final int HINT_BLOCK_META_GENERIC_6
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_7
public static final int HINT_BLOCK_META_GENERIC_7
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_8
public static final int HINT_BLOCK_META_GENERIC_8
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_9
public static final int HINT_BLOCK_META_GENERIC_9
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_10
public static final int HINT_BLOCK_META_GENERIC_10
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_GENERIC_11
public static final int HINT_BLOCK_META_GENERIC_11
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_DEFAULT
public static final int HINT_BLOCK_META_DEFAULT
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_AIR
public static final int HINT_BLOCK_META_AIR
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_NOT_AIR
public static final int HINT_BLOCK_META_NOT_AIR
- See Also:
- Constant Field Values
-
HINT_BLOCK_META_ERROR
public static final int HINT_BLOCK_META_ERROR
- See Also:
- Constant Field Values
-
-
Method Detail
-
enableInstrument
public static void enableInstrument(java.lang.Object identifier)
Start instrumenting for the current thread only. When instrumentation is enabled,IStructureDefinition's builtin iteration methods will sendStructureEventand its subclasses when appropriate. Otherwise, these events will not be sent at all, regardless of whether a listener for these events are registered.Identifiers are required to be value-comparable, i.e. overrides
Object.equals(Object). Suggested identifier includes- Mod Instance or
ModContainer IConstructableand its friends, if you are triggering structure check via this interface.ResourceLocation
It's an API abuse for normal
IStructureDefinitionusers to depend on this feature. They have full control and full knowledge of theIStructureDefinitionthey are using. Using events to instrument the structure check/autoplace is completely unnecessary and does nothing but add overhead.Instruments are required to call
disableInstrument()whenever it is done with its business, as there can be only one instrument for any given thread.- Parameters:
identifier- an identifier sent along the actual event.- Throws:
java.lang.IllegalStateException- if instrument has already been enabled.
- Mod Instance or
-
disableInstrument
public static void disableInstrument()
Stop instrumenting.- Throws:
java.lang.IllegalStateException- if instrumenting hasn't been enabled.
-
isInstrumentEnabled
public static boolean isInstrumentEnabled()
Check if instrumenting is enabled.- Returns:
- true if enabled, false otherwise
-
startHinting
public static void startHinting(World w)
Start a batch of hinting. All hints particles generated during one batch will be considered to belong to one hologram.You don't need to call this unless your constructable tool didn't call
ConstructableUtility.handle(ItemStack, EntityPlayer, World, int, int, int, int)
-
endHinting
public static void endHinting(World w)
End current batch of hinting. All hints particles generated during one batch will be considered to belong to one hologram.You don't need to call this unless your constructable tool didn't call
ConstructableUtility.handle(ItemStack, EntityPlayer, World, int, int, int, int)
-
hintParticleTinted
public static void hintParticleTinted(World w, int x, int y, int z, IIcon[] icons, short[] RGBa)
Generate a new hint particle on client side at given location using given textures with a tint.- Parameters:
w- World to spawn. Usually the client world.x- x coordy- y coordz- z coordicons- 6 texture. in forge direction order.RGBa- a 4 short array. tint in rgba form. currently alpha channel is ignored, but we might change this later on.
-
hintParticleTinted
public static void hintParticleTinted(World w, int x, int y, int z, Block block, int meta, short[] RGBa)
Generate a new hint particle on client side at given location using textures from given block with a tint.- Parameters:
w- World to spawn. Usually the client world.x- x coordy- y coordz- z coordblock- block to take texture frommeta- the meta of block to take texture fromRGBa- a 4 short array. tint in rgba form. currently alpha channel is ignored, but we might change this later on.
-
hintParticle
public static void hintParticle(World w, int x, int y, int z, IIcon[] icons)
Generate a new hint particle on client side at given location using given textures.- Parameters:
w- World to spawn. Usually the client world.x- x coordy- y coordz- z coordicons- 6 texture. in forge direction order.
-
hintParticle
public static void hintParticle(World w, int x, int y, int z, Block block, int meta)
Generate a new hint particle on client side at given location using textures from given block.- Parameters:
w- World to spawn. Usually the client world.x- x coordy- y coordz- z coordblock- block to take texture frommeta- the meta of block to take texture from
-
markHintParticleError
public static boolean markHintParticleError(EntityPlayer player, World w, int x, int y, int z)
Update the tint of given hint particle. Do nothing if particle not found.Can be called on either client side or server side. Server side will schedule a network message to update it for this player only. Will do nothing if no hint particle is found at given location.
- Returns:
- false if nothing updated. true if updated or update instruction sent.
-
updateHintParticleTint
public static boolean updateHintParticleTint(EntityPlayer player, World w, int x, int y, int z, short[] RGBa)
Update the tint of given hint particle. Do nothing if particle not found.- Returns:
- false if nothing updated. true if updated.
-
queryAlignment
public static void queryAlignment(IAlignmentProvider provider)
Query the ExtendedFacing of this tile entity from client side. Can be sent only on client side. The ExtendedFacing will later be set onto given tile entity viaIAlignment.setExtendedFacing(ExtendedFacing)upon arrival of server reply.The server side will query the
ExtendedFacingof this provider usingIAlignment.getExtendedFacing()- Throws:
java.lang.IllegalArgumentException- if is not tile entity or provided a null alignment
-
sendAlignment
public static void sendAlignment(IAlignmentProvider provider)
Send the ExtendedFacing of this Tile Entity to all players. Can be called on server side only.The receiving tile entity will receive the
ExtendedFacingvia itsIAlignment.setExtendedFacing(ExtendedFacing)method.- Throws:
java.lang.IllegalArgumentException- if is not tile entity or provided a null alignment
-
sendAlignment
public static void sendAlignment(IAlignmentProvider provider, EntityPlayerMP player)
Send the ExtendedFacing of this Tile Entity to given player. Can be called on server side only.The receiving tile entity will receive the
ExtendedFacingvia itsIAlignment.setExtendedFacing(ExtendedFacing)method.- Throws:
java.lang.IllegalArgumentException- if is not tile entity or provided a null alignment
-
sendAlignment
public static void sendAlignment(IAlignmentProvider provider, NetworkRegistry.TargetPoint targetPoint)
Send the ExtendedFacing of this Tile Entity to all players around target point. Can be called on server side only.The receiving tile entity will receive the
ExtendedFacingvia itsIAlignment.setExtendedFacing(ExtendedFacing)method.- Throws:
java.lang.IllegalArgumentException- if is not tile entity or provided a null alignment
-
sendAlignment
public static void sendAlignment(IAlignmentProvider provider, World dimension)
Send the ExtendedFacing of this Tile Entity to all players in that dimension. Can be called on server side only.The receiving tile entity will receive the
ExtendedFacingvia itsIAlignment.setExtendedFacing(ExtendedFacing)method.- Throws:
java.lang.IllegalArgumentException- if is not tile entity or provided a null alignment
-
getBlockHint
public static Block getBlockHint()
Get the Block for StructureLib supplied hint block.
-
getItemBlockHint
public static Item getItemBlockHint()
Get the ItemBlock for StructureLib supplied hint block.
-
getDefaultHologramItem
public static Item getDefaultHologramItem()
Get the hologram item.
-
isDebugEnabled
public static boolean isDebugEnabled()
Check if structure debug mode is on.- Returns:
- true if debug mode is on
-
setDebugEnabled
public static void setDebugEnabled(boolean enabled)
-
isBlockTriviallyReplaceable
@Deprecated public static boolean isBlockTriviallyReplaceable(World w, int x, int y, int z, EntityPlayerMP actor)
Deprecated.Determines if given block can be replaced without much effort. The exact predicate clauses is not stable and will be changed, but the general idea will always stay the same.Use this in your
IStructureElement.survivalPlaceBlock(Object, World, int, int, int, ItemStack, AutoPlaceEnvironment)
-
isBlockTriviallyReplaceable
public static boolean isBlockTriviallyReplaceable(World w, int x, int y, int z, EntityPlayer actor)
Determines if given block can be replaced without much effort. The exact predicate clauses is not stable and will be changed, but the general idea will always stay the same.Use this in your
IStructureElement.survivalPlaceBlock(Object, World, int, int, int, ItemStack, AutoPlaceEnvironment)
-
addThrottledChat
public static void addThrottledChat(java.lang.Object throttleKey, EntityPlayer player, IChatComponent text, short intervalRequired)Send chat to player, but throttled.- Parameters:
throttleKey- throttle key. Must properly implementObject.hashCode()andObject.equals(Object)to handle value equality.player- player to send chat totext- chat to sendintervalRequired- interval required before last recorded time to actually send the message. unit in millisecond. we purposefully chose to not use a bigger data type to limit how long this interval can be
-
addThrottledChat
public static void addThrottledChat(java.lang.Object throttleKey, EntityPlayer player, IChatComponent text, short intervalRequired, boolean forceUpdateLastSend)Send chat to player, but throttled.- Parameters:
throttleKey- throttle key. Must properly implementObject.hashCode()andObject.equals(Object)to handle value equality.player- player to send chat totext- chat to sendintervalRequired- interval required before last recorded time to actually send the message. unit in millisecond. we purposefully chose to not use a bigger data type to limit how long this interval can beforceUpdateLastSend- if true, always update the last send time, even if the message isn't actually sent.
-
-