This is a method function for
GetEntities annotation. It will resolve an
GetEntitiesMethod to be used by the entity typing system. This differs from the usual
getting of
Entity as it also lets gain a subset of
Entity using
EntityID
(so adding to any method will cause it to filter).
The next example signature will resolve to
EntityContainer.getEntities().
@GetEntities
Set<Entity> getGhosts();
The next example signature will resolve to
EntityContainer.getEntitiesOfType(Class).
@GetEntities
Set<Ghost> getGhosts();
The next example signature will resolve to
EntityContainer.getEntitiesAsType(Class).
@GetEntities(ofType = false)
Set<Ghost> getGhosts();
The next example signature will show how to use one of the above examples with a subset.
@EntityID(mostSigBits = 0, leastSigBits = 1)
@EntityID(mostSigBits = 0, leastSigBits = 2)
@EntityID(mostSigBits = 0, leastSigBits = 3)
@EntityID(mostSigBits = 0, leastSigBits = 4)
@EntityID(mostSigBits = 0, leastSigBits = 5)
@GetEntities
Stream<Ghost> getGhosts();
NOTE: This function will throw exceptions if
GetEntities is present but the method
signature is invalid.