h1z1-server
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    _containers: { [loadoutSlotId: number]: LoadoutContainer } = {}
    _equipment: { [equipmentSlotId: number]: CharacterEquipment } = {}
    _loadout: { [loadoutSlotId: number]: LoadoutItem } = {}
    _resources: { [resourceId: number]: number } = {}

    BaseFullCharacter loadout values

    actorModelId: number

    Id of the model that corresponds to the entity

    characterId: string

    Universal Identifier, used for locating the home of an entity

    currentLoadoutSlot: number = 0
    defaultLoadout: LoadoutKit = []

    The default items that will spawn on and with the BaseFullCharacter

    effectTags: number[] = []

    Used for vehicle abilities, array of the corresponding vehicles effects

    flags: {
        bit0: number;
        bit1: number;
        bit10: number;
        bit11: number;
        bit13: number;
        bit14: number;
        bit15: number;
        bit16: number;
        bit17: number;
        bit18: number;
        bit19: number;
        bit2: number;
        bit22: number;
        bit23: number;
        bit3: number;
        bit4: number;
        bit5: number;
        bit6: number;
        bit7: number;
        bit9: number;
        knockedOut: number;
        noCollide: number;
        nonAttackable: number;
        projectileCollision: number;
    } = ...

    Adjustable flags for the lightweight, useful flags: nonAttackable - disables melee flinch noCollide - determines if NpcCollision packet gets sent on player collide bit13 - causes a crash if 1 with noCollide 1 knockedOut - currently used for determining if a character is dead

    gender: number
    h1emu_ai_id?: bigint
    headActor: string = ...

    Returns the modelId of the lightweight, zombies or players

    health: number = 1000000

    Health of the lightweight

    hoodState: string = "Up"
    interactionDistance: number = 4

    Distance (H1Z1 meters) at which the player can interact with the BaseLootableEntity

    isLightweight: boolean = false

    Returns true if the character is a lightweight

    isLootbag: boolean

    Determines if the entity BaseLootableEntity should be a lootbag, Returns true if the modelId is included in the array below

    loadoutId: number = 5
    materialType: number

    The physical material the entity is made of - See enums.ts/MaterialTypes for more information

    maxHealth: number = 1000000

    Maximum health of the lightweight

    mountedCharacter?: string

    The current character interacting with the BaseLootableEntity

    movementVersion: number = 0
    nameId: number = 0

    Id of the lightweight, used in determining the proper name for HUDTimer and InteractionString

    navAgent?: CrowdAgent
    npcRenderDistance: number

    Distance (H1Z1 meters) where the entity will render, when undefined, uses the zoneserver._charactersRenderDistance value instead

    onReadyCallback?: (clientTriggered: ZoneClient2016) => void

    Callback for OnFullCharacterDataRequest

    positionUpdateType: PositionUpdateType = PositionUpdateType.STATIC

    Determines if the lightweight is moving with the positionUpdate - Avcio

    profileId: number = 0

    Used for constructions

    scale: Float32Array<ArrayBuffer> = ...

    Physical size of the entity based on the entity model

    shouldSpawnLoot: boolean

    Used to determine whether the modelId should spawn loot when the global respawns occur, Returns false if the modelId is not included in the array below

    state: {
        lookAt: Float32Array;
        position: Float32Array;
        rotation: Float32Array;
        yaw: number;
    }

    State of the BaseLightweightCharacter, includes: state (Float32Array), rotation(Float32Array), lookAt(Float32Array), and yaw (number)

    temporaryActorModelId?: number
    transientId: number

    Required for interactable entities, npc and interaction components packet

    useSimpleStruct: boolean = false

    Determines if the lightweight should be used as a SimpleNpc (non-moving)

    Methods

    • Equips an item to a BaseFullCharacter.

      Parameters

      • server: ZoneServer2016

        The ZoneServer instance.

      • Optionalitem: BaseItem

        The item to equip.

      • sendPacket: boolean = true

        Optional: Only used if character param belongs to a client. Sends equipment, loadout, and item update packets to client if true.

      • loadoutSlotId: number = 0

        Optional: The loadoutSlotId to manually try to equip the item to. This will be found automatically if not defined.

      Returns void

    • Parameters

      • slotId: number

      Returns
          | undefined
          | {
              decalAlias: string;
              effectId: number;
              modelName: string;
              SHADER_PARAMETER_GROUP: { SHADER_SEMANTIC_ID: number }[];
              slotId: number;
              textureAlias: string;
              tintAlias: string;
          }

    • Returns (
          | undefined
          | {
              decalAlias: string;
              effectId: number;
              modelName: string;
              SHADER_PARAMETER_GROUP: { SHADER_SEMANTIC_ID: number }[];
              slotId: number;
              textureAlias: string;
              tintAlias: string;
          }
      )[]

    • Parameters

      Returns {
          associatedCharacterId: string;
          bulkUsed: number;
          definitionId: number;
          guid: string;
          hasBulkLimit: boolean;
          items: {
              itemData: {
                  baseDurability: number;
                  containerDefinitionId: number;
                  containerGuid: string;
                  containerSlotId: number;
                  count: number;
                  currentDurability: number;
                  guid: string;
                  itemDefinitionId: number;
                  itemSubData: { hasSubData: boolean };
                  maxDurabilityFromDefinition: number;
                  ownerCharacterId: string;
                  tintId: number;
                  unknownBoolean1: boolean;
                  unknownDword9: number;
                  weaponData:
                      | {
                          characterStats: never[];
                          isWeapon: boolean;
                          unknownArray1: never[];
                          unknownBoolean1?: undefined;
                          unknownData1: { unknownBoolean1: boolean };
                          unknownData2: {
                              ammoSlots: { ammoSlot: number }[];
                              equipmentSlotId: number;
                              firegroups: {
                                  firegroupId: any;
                                  unknownArray1: {
                                      unknownByte1: ...;
                                      unknownDword1: ...;
                                      unknownDword2: ...;
                                      unknownDword3: ...;
                                  }[];
                              }[];
                              unknownByte2: number;
                              unknownByte3: number;
                              unknownByte4: number;
                              unknownByte5: number;
                              unknownByte6: number;
                              unknownByte7: number;
                              unknownDword1: number;
                              unknownDword2: number;
                              unknownDword3: number;
                              unknownFloat1: number;
                          };
                      }
                      | {
                          characterStats?: undefined;
                          isWeapon: boolean;
                          unknownArray1?: undefined;
                          unknownBoolean1: boolean;
                          unknownData1?: undefined;
                          unknownData2?: undefined;
                      };
              };
              itemDefinitionId: number;
          }[];
          maxBulk: number;
          showBulk: boolean;
          slots: any;
          unknownDword1: number;
      }

    • Parameters

      Returns {
          containerData: {
              associatedCharacterId: string;
              bulkUsed: number;
              definitionId: number;
              guid: string;
              hasBulkLimit: boolean;
              items: {
                  itemData: {
                      baseDurability: number;
                      containerDefinitionId: number;
                      containerGuid: string;
                      containerSlotId: number;
                      count: number;
                      currentDurability: number;
                      guid: string;
                      itemDefinitionId: number;
                      itemSubData: { hasSubData: boolean };
                      maxDurabilityFromDefinition: number;
                      ownerCharacterId: string;
                      tintId: number;
                      unknownBoolean1: boolean;
                      unknownDword9: number;
                      weaponData:
                          | {
                              characterStats: never[];
                              isWeapon: boolean;
                              unknownArray1: never[];
                              unknownBoolean1?: undefined;
                              unknownData1: { unknownBoolean1: boolean };
                              unknownData2: {
                                  ammoSlots: { ammoSlot: ... }[];
                                  equipmentSlotId: number;
                                  firegroups: { firegroupId: ...; unknownArray1: ... }[];
                                  unknownByte2: number;
                                  unknownByte3: number;
                                  unknownByte4: number;
                                  unknownByte5: number;
                                  unknownByte6: number;
                                  unknownByte7: number;
                                  unknownDword1: number;
                                  unknownDword2: number;
                                  unknownDword3: number;
                                  unknownFloat1: number;
                              };
                          }
                          | {
                              characterStats?: undefined;
                              isWeapon: boolean;
                              unknownArray1?: undefined;
                              unknownBoolean1: boolean;
                              unknownData1?: undefined;
                              unknownData2?: undefined;
                          };
                  };
                  itemDefinitionId: number;
              }[];
              maxBulk: number;
              showBulk: boolean;
              slots: any;
              unknownDword1: number;
          };
          loadoutSlotId: number;
      }[]

    • Parameters

      • slotId: number

      Returns
          | undefined
          | {
              equipmentSlotData: {
                  decalAlias: string;
                  effectId: number;
                  equipmentSlotId: number;
                  guid: string;
                  tintAlias: string;
              };
              equipmentSlotId: number;
          }

    • Parameters

      • slotId: number

      Returns
          | undefined
          | {
              attachmentData: | undefined
              | {
                  decalAlias: string;
                  effectId: number;
                  modelName: string;
                  SHADER_PARAMETER_GROUP: { SHADER_SEMANTIC_ID: number }[];
                  slotId: number;
                  textureAlias: string;
                  tintAlias: string;
              };
              characterData: { characterId: string };
              equipmentSlot:
                  | undefined
                  | {
                      equipmentSlotData: {
                          decalAlias: string;
                          effectId: number;
                          equipmentSlotId: number;
                          guid: string;
                          tintAlias: string;
                      };
                      equipmentSlotId: number;
                  };
          }

    • Returns (
          | undefined
          | {
              equipmentSlotData: {
                  decalAlias: string;
                  effectId: number;
                  equipmentSlotId: number;
                  guid: string;
                  tintAlias: string;
              };
              equipmentSlotId: number;
          }
      )[]

    • Parameters

      Returns {
          baseDurability: number;
          containerDefinitionId: number;
          containerGuid: string;
          containerSlotId: number;
          count: number;
          currentDurability: number;
          guid: string;
          itemDefinitionId: number;
          itemSubData: { hasSubData: boolean };
          maxDurabilityFromDefinition: number;
          ownerCharacterId: string;
          tintId: number;
          unknownBoolean1: boolean;
          unknownDword9: number;
          weaponData:
              | {
                  characterStats: never[];
                  isWeapon: boolean;
                  unknownArray1: never[];
                  unknownBoolean1?: undefined;
                  unknownData1: { unknownBoolean1: boolean };
                  unknownData2: {
                      ammoSlots: { ammoSlot: number }[];
                      equipmentSlotId: number;
                      firegroups: {
                          firegroupId: any;
                          unknownArray1: {
                              unknownByte1: number;
                              unknownDword1: number;
                              unknownDword2: number;
                              unknownDword3: number;
                          }[];
                      }[];
                      unknownByte2: number;
                      unknownByte3: number;
                      unknownByte4: number;
                      unknownByte5: number;
                      unknownByte6: number;
                      unknownByte7: number;
                      unknownDword1: number;
                      unknownDword2: number;
                      unknownDword3: number;
                      unknownFloat1: number;
                  };
              }
              | {
                  characterStats?: undefined;
                  isWeapon: boolean;
                  unknownArray1?: undefined;
                  unknownBoolean1: boolean;
                  unknownData1?: undefined;
                  unknownData2?: undefined;
              };
      }[]

    • Parameters

      Returns {
          baseDurability: number;
          containerDefinitionId: number;
          containerGuid: string;
          containerSlotId: number;
          count: number;
          currentDurability: number;
          guid: string;
          itemDefinitionId: number;
          itemSubData: { hasSubData: boolean };
          maxDurabilityFromDefinition: number;
          ownerCharacterId: string;
          tintId: number;
          unknownBoolean1: boolean;
          unknownDword9: number;
          weaponData:
              | {
                  characterStats: never[];
                  isWeapon: boolean;
                  unknownArray1: never[];
                  unknownBoolean1?: undefined;
                  unknownData1: { unknownBoolean1: boolean };
                  unknownData2: {
                      ammoSlots: { ammoSlot: number }[];
                      equipmentSlotId: number;
                      firegroups: {
                          firegroupId: any;
                          unknownArray1: {
                              unknownByte1: number;
                              unknownDword1: number;
                              unknownDword2: number;
                              unknownDword3: number;
                          }[];
                      }[];
                      unknownByte2: number;
                      unknownByte3: number;
                      unknownByte4: number;
                      unknownByte5: number;
                      unknownByte6: number;
                      unknownByte7: number;
                      unknownDword1: number;
                      unknownDword2: number;
                      unknownDword3: number;
                      unknownFloat1: number;
                  };
              }
              | {
                  characterStats?: undefined;
                  isWeapon: boolean;
                  unknownArray1?: undefined;
                  unknownBoolean1: boolean;
                  unknownData1?: undefined;
                  unknownData2?: undefined;
              };
      }

    • Parameters

      Returns
          | {
              characterStats: never[];
              isWeapon: boolean;
              unknownArray1: never[];
              unknownBoolean1?: undefined;
              unknownData1: { unknownBoolean1: boolean };
              unknownData2: {
                  ammoSlots: { ammoSlot: number }[];
                  equipmentSlotId: number;
                  firegroups: {
                      firegroupId: any;
                      unknownArray1: {
                          unknownByte1: number;
                          unknownDword1: number;
                          unknownDword2: number;
                          unknownDword3: number;
                      }[];
                  }[];
                  unknownByte2: number;
                  unknownByte3: number;
                  unknownByte4: number;
                  unknownByte5: number;
                  unknownByte6: number;
                  unknownByte7: number;
                  unknownDword1: number;
                  unknownDword2: number;
                  unknownDword3: number;
                  unknownFloat1: number;
              };
          }
          | {
              characterStats?: undefined;
              isWeapon: boolean;
              unknownArray1?: undefined;
              unknownBoolean1: boolean;
              unknownData1?: undefined;
              unknownData2?: undefined;
          }

    • Parameters

      • slotId: number

      Returns {
          hotbarSlotId: number;
          loadoutId: number;
          loadoutItemData: {
              itemDefinitionId: number;
              loadoutItemGuid: string;
              unknownByte1: number;
          };
          slotId: number;
          unknownDword1: number;
      }

    • Returns {
          characterId: string;
          currentSlotId: number;
          loadoutData: {
              loadoutSlots: {
                  hotbarSlotId: number;
                  loadoutId: number;
                  loadoutItemData: {
                      itemDefinitionId: number;
                      loadoutItemGuid: string;
                      unknownByte1: number;
                  };
                  slotId: number;
                  unknownDword1: number;
              }[];
          };
          loadoutId: number;
      }

    • Returns {
          resourceData: {
              resourceId: number;
              resourceType: number;
              value: number;
          };
          resourceType: number;
      }[]