Interface IUserAvatarManager

User avatar management interface.

interface IUserAvatarManager {
    getNearestUser(
        center: { x: number; y: number; z: number },
    ): UserAvatar | null;
    getUser(userId: string): UserAvatar | undefined;
    getUserCount(): number;
    getUsers(): UserAvatar[];
    getUsersInRange(
        center: { x: number; y: number; z: number },
        radius: number,
    ): UserAvatar[];
    off(event: UserAvatarEvent, handler: (user: UserAvatar) => void): void;
    on(event: UserAvatarEvent, handler: (user: UserAvatar) => void): void;
}

Index

Methods

getNearestUser getUser getUserCount getUsers getUsersInRange off on

Methods

getNearestUser

getNearestUser(center: { x: number; y: number; z: number }): UserAvatar | null
Gets the nearest user.
Parameters
- center: { x: number; y: number; z: number }
  Reference position.
Returns UserAvatar | null
Nearest user, or null when no user exists.
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:73

getUser

getUser(userId: string): UserAvatar | undefined
Gets information for a specific user.
Parameters
- userId: string
  User ID.
Returns UserAvatar | undefined
User avatar information, or undefined when the user does not exist.
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:52

getUserCount

getUserCount(): number
Gets the current user count.

Returns number
Number of users.
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:58

getUsers

getUsers(): UserAvatar[]
Gets all current user avatar information.

Returns UserAvatar[]
Array of user avatar information.
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:45

getUsersInRange

getUsersInRange(
center: { x: number; y: number; z: number },
radius: number,
): UserAvatar[]
Gets users within the specified range.
Parameters
- center: { x: number; y: number; z: number }
  Center position.
- radius: number
  Radius.
Returns UserAvatar[]
Array of user avatar information within the range.
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:66

off

off(event: UserAvatarEvent, handler: (user: UserAvatar) => void): void
Unregisters an event handler.
Parameters
- event: UserAvatarEvent
  Event name.
- handler: (user: UserAvatar) => void
  Event handler.
Returns void
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:87

on

on(event: UserAvatarEvent, handler: (user: UserAvatar) => void): void
Registers an event handler.
Parameters
- event: UserAvatarEvent
  Event name.
- handler: (user: UserAvatar) => void
  Event handler.
Returns void
- Defined in packages/core/src/interfaces/IUserAvatarManager.ts:80