BBPGlue.API.BBPEntities Class Reference

Utilities for enumerating and querying entities (NPCs and players) in the world. More...

Public Member Functions
BBPNpc?	GetClosestNpc (Vector3 position)
	Finds the NPC closest to the specified position.
BBPPlayerRef?	GetClosestPlayer (Vector3 position)
	Finds the player reference closest to the specified position.
List< BBPNpc >	GetNpcs ()
	Enumerates NPCs present in the environment and returns wrappers for them.
List< BBPPlayerRef >	GetPlayers ()
	Enumerates player references in the environment.

Properties
BBPNpc?	ClosestNpc [get]
	The NPC closest to the player position.
BBPPlayerRef?	ClosestPlayer [get]
	The player reference closest to the player position (useful in multiplayer scenarios).
IReadOnlyList< BBPNpc >	Npcs [get]
	Read-only list of NPC wrappers present in the environment.
IReadOnlyList< BBPPlayerRef >	Players [get]
	Read-only list of player references present in the environment.

Detailed Description

Utilities for enumerating and querying entities (NPCs and players) in the world.

Member Function Documentation

GetClosestNpc()

BBPNpc? BBPGlue.API.BBPEntities.GetClosestNpc

(

Vector3

position

)

Finds the NPC closest to the specified position.

Parameters

position

Position to measure distance from.

Returns

The closest BBPNpc or null if none found.

GetClosestPlayer()

BBPPlayerRef? BBPGlue.API.BBPEntities.GetClosestPlayer

(

Vector3

position

)

Finds the player reference closest to the specified position.

Parameters

position

Position to measure distance from.

Returns

The closest BBPPlayerRef or null if none found.

GetNpcs()

List< BBPNpc > BBPGlue.API.BBPEntities.GetNpcs

(

)

Enumerates NPCs present in the environment and returns wrappers for them.

Returns

List of BBPNpc wrappers.

GetPlayers()

List< BBPPlayerRef > BBPGlue.API.BBPEntities.GetPlayers

(

)

Enumerates player references in the environment.

Returns

List of BBPPlayerRef wrappers.

Property Documentation

ClosestNpc

BBPNpc? BBPGlue.API.BBPEntities.ClosestNpc

get

The NPC closest to the player position.

ClosestPlayer

BBPPlayerRef? BBPGlue.API.BBPEntities.ClosestPlayer

get

The player reference closest to the player position (useful in multiplayer scenarios).

Npcs

IReadOnlyList<BBPNpc> BBPGlue.API.BBPEntities.Npcs

get

Read-only list of NPC wrappers present in the environment.

Players

IReadOnlyList<BBPPlayerRef> BBPGlue.API.BBPEntities.Players

get

Read-only list of player references present in the environment.

---

The documentation for this class was generated from the following file:

• BBPEntities.cs