pterodactyl.ts
    Preparing search index...

    Class ServerBuilder

    Index

    Constructors

    Methods

    • Add environment vars with which the server will start

      Parameters

      • key: string
      • value: string

      Returns ServerBuilder

      environment This will use the default environment if you set the egg via .setEgg(egg: PanelEgg)
      
    • Enable the OOM killer This will kill the server if it exceeds the memory limit This may cause the server processes to exit unexpectedly This CAN cause to data corruption

      Parameters

      • enabled: boolean

      Returns ServerBuilder

      false
      
    • Parameters

      • cpuLimit: number

        in %

      Returns ServerBuilder

      0
      

    • Set a custom limit for this server

      Parameters

      • name: string

        The name of the limit, e.g. 'splits'

      • value: string | number

        The value of the limit

      Returns ServerBuilder

    • Set the environment vars with which the server will start

      Parameters

      • environment: { [environment: string]: string }

      Returns ServerBuilder

      environment This will use the default environment if you set the egg via .setEgg(egg: PanelEgg)
      
    • Set all feature limits for this server at once

      Parameters

      • limits: { allocations: number; backups: number; databases: number }

        The Limits you want to set

      Returns ServerBuilder

    • Set all limits for this server at once

      Parameters

      • limits: {
            cpu: number;
            disk: number;
            io: number;
            memory: number;
            swap: number;
            threads: string | undefined;
        }

        The Limits you want to set

      Returns ServerBuilder

    • Set the startup command with which the server will start This can include environment vars via {{ VAR_NAME }}

      Parameters

      • startup: string

      Returns ServerBuilder

      startup This will use the default startup command if you set the egg via .setEgg(egg: PanelEgg)