CollisionType (Rising World Plugin API)

java.lang.Object
- net.risingworld.api.utils.CollisionType

```
public class CollisionType
extends java.lang.Object
```
A class containing static variables representing various collision types, which are used for ray casting. These variables can be used to create a "bitmask" by combining multiple collision types, e.g. "CollisionType.TERRAIN | CollisionType.CONSTRUCTIONS | CollisionType.OBJECTS"

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APIELEMENTS` API elements (custom objects created via API, e.g.
`static int`	`BITMASK_BUILDING` Default building collision bitmask (for example used when the player wants to place an object).
`static int`	`BITMASK_DEFAULT` Default player picking collision bitmask.
`static int`	`CHOPPEDTREES` Chopped trees
`static int`	`CONSTRUCTIONS` Construction elements (blocks, planks, beams etc)
`static int`	`CONSTRUCTIONSBOUND` Construction elements (blocks, planks, beams etc)
`static int`	`CORPSES` Corpses (player corpses, NPC corpses etc)
`static int`	`GRASS` Grass blades
`static int`	`ITEMS` Items (world items)
`static int`	`LOCALPLAYER` Local player (i.e. the client the raycast is performed on)
`static int`	`NPCS` NPCs (animals, monsters etc), actual NPC mesh
`static int`	`NPCSBOUND` Bounding volume of NPCs (i.e. rough area around NPCs).
`static int`	`NULL` No collision
`static int`	`OBJECTS` Objects (furniture, doors, torches etc), actual object mesh
`static int`	`OBJECTSBOUND` Bounding volume of objects (i.e. rough area around objects like furniture).
`static int`	`PLAYERS` Players (does not include the client the raycast is performed on)
`static int`	`TERRAIN` Terrain
`static int`	`TREES` Trees (does not include small plants, crops etc).
`static int`	`VEGETATIONS` All types of vegetation (trees, plants, flowers, crops etc)
`static int`	`VEHICLES` Vehicles
`static int`	`WATER` Water surfaces (ponds, lakes, oceans etc)

Constructor Summary

Constructors
Constructor and Description

CollisionType()

Constructors
Constructor and Description
`CollisionType()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`checkCollisionBitmask(int type, int bitmask)` Checks if the provided bitmask "contains" the specified collision type.
`static int`	`getBitmask(int... collisionTypes)` Gets a bitmask of the provided collision types.

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

Field Detail
- NULL
```
public static final int NULL
```
  No collision
  
  See Also:
  
  Constant Field Values
- TERRAIN
```
public static final int TERRAIN
```
  Terrain
  
  See Also:
  
  Constant Field Values
- WATER
```
public static final int WATER
```
  Water surfaces (ponds, lakes, oceans etc)
  
  See Also:
  
  Constant Field Values
- GRASS
```
public static final int GRASS
```
  Grass blades
  
  See Also:
  
  Constant Field Values
- CONSTRUCTIONS
```
public static final int CONSTRUCTIONS
```
  Construction elements (blocks, planks, beams etc)
  
  See Also:
  
  Constant Field Values
- CONSTRUCTIONSBOUND
```
public static final int CONSTRUCTIONSBOUND
```
  Construction elements (blocks, planks, beams etc)
  
  See Also:
  
  Constant Field Values
- OBJECTS
```
public static final int OBJECTS
```
  Objects (furniture, doors, torches etc), actual object mesh
  
  See Also:
  
  Constant Field Values
- OBJECTSBOUND
```
public static final int OBJECTSBOUND
```
  Bounding volume of objects (i.e. rough area around objects like furniture). Do not use in combination with OBJECTS
  
  See Also:
  
  Constant Field Values
- VEGETATIONS
```
public static final int VEGETATIONS
```
  All types of vegetation (trees, plants, flowers, crops etc)
  
  See Also:
  
  Constant Field Values
- TREES
```
public static final int TREES
```
  Trees (does not include small plants, crops etc). Do not use in combination with VEGETATIONS
  
  See Also:
  
  Constant Field Values
- CHOPPEDTREES
```
public static final int CHOPPEDTREES
```
  Chopped trees
  
  See Also:
  
  Constant Field Values
- PLAYERS
```
public static final int PLAYERS
```
  Players (does not include the client the raycast is performed on)
  
  See Also:
  
  Constant Field Values
- LOCALPLAYER
```
public static final int LOCALPLAYER
```
  Local player (i.e. the client the raycast is performed on)
  
  See Also:
  
  Constant Field Values
- NPCS
```
public static final int NPCS
```
  NPCs (animals, monsters etc), actual NPC mesh
  
  See Also:
  
  Constant Field Values
- NPCSBOUND
```
public static final int NPCSBOUND
```
  Bounding volume of NPCs (i.e. rough area around NPCs). Do not use in combination with NPCS
  
  See Also:
  
  Constant Field Values
- CORPSES
```
public static final int CORPSES
```
  Corpses (player corpses, NPC corpses etc)
  
  See Also:
  
  Constant Field Values
- ITEMS
```
public static final int ITEMS
```
  Items (world items)
  
  See Also:
  
  Constant Field Values
- VEHICLES
```
public static final int VEHICLES
```
  Vehicles
  
  See Also:
  
  Constant Field Values
- APIELEMENTS
```
public static final int APIELEMENTS
```
  API elements (custom objects created via API, e.g. World3DModel)
  
  See Also:
  
  Constant Field Values
- BITMASK_DEFAULT
```
public static final int BITMASK_DEFAULT
```
  Default player picking collision bitmask. Includes Npcs, Players, Corpses, Items, Chopped trees, API elements, Vegetations, Terrain, Constructions, Objects and Vehicles
- BITMASK_BUILDING
```
public static final int BITMASK_BUILDING
```
  Default building collision bitmask (for example used when the player wants to place an object). Includes API elements, Vegetations, Terrain, Constructions and Objects

Constructor Detail
- CollisionType
```
public CollisionType()
```

Method Detail

getBitmask
```
public static int getBitmask(int... collisionTypes)
```
Gets a bitmask of the provided collision types. This can be used to "combine" various collision types, e.g. if you want to get a bitmask representing "TERRAIN" and "BLOCKS" collision, you can call getBitmask(CollisionType.TERRAIN, CollisionType.BLOCKS);
Internally this method just uses the bitwise or operator to create the bitmask (e.g. int bitmask = CollisionType.TERRAIN | CollisionType.BLOCKS;)

Parameters:

collisionTypes - the collision types you want to "combine"

Returns:

a bitmask of the combined collision types.

checkCollisionBitmask

public static boolean checkCollisionBitmask(int type,
                                            int bitmask)

Checks if the provided bitmask "contains" the specified collision type. I.e. to check if a bitmask also includes "CONSTRUCTIONS" collisions, you can call checkCollisionBitmask(CollisionType.CONSTRUCTIONS, bitmask);

Parameters:

type - the collision type (e.g. "TERRAIN", "BLOCKS", "OBJECTS" etc.)

bitmask - the collision type bitmask

Returns:

true if the provided bitmask "contains" the specified collision type, false if not.

Example:

1	int collA = CollisionType.getBitmask(CollisionType.TERRAIN, CollisionType.BLOCKS, CollisionType.CONSTRUCTIONS);
2	int collB = CollisionType.VEGETATIONS;
3
4	// returns true
5	CollisionType.checkCollisionBitmask(CollisionType.BLOCKS, collA);
6	// returns false
7	CollisionType.checkCollisionBitmask(CollisionType.PLAYERS, collA);
8	// returns true
9	CollisionType.checkCollisionBitmask(CollisionType.TERRAIN, collA);
10	// returns false
11	CollisionType.checkCollisionBitmask(CollisionType.TERRAIN, collB);
12	// returns true
13	CollisionType.checkCollisionBitmask(CollisionType.VEGETATIONS, collB);

Class CollisionType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

TERRAIN

WATER

GRASS

CONSTRUCTIONS

CONSTRUCTIONSBOUND

OBJECTS

OBJECTSBOUND

VEGETATIONS

TREES

CHOPPEDTREES

PLAYERS

LOCALPLAYER

NPCS

NPCSBOUND

CORPSES

ITEMS

VEHICLES

APIELEMENTS

BITMASK_DEFAULT

BITMASK_BUILDING

Constructor Detail

CollisionType

Method Detail

getBitmask

checkCollisionBitmask