Skip to main content

RequirePoolSize

This function was added in DSL 6

Description​

Makes sure a pool is at least a certain size.

This is a header function, meaning it is meant to go on the top of your main script as an alternative to using config.txt.

This function makes sure that a pool is at least a certain size. Pool names are the same as the ones used with GetPoolSize.

If the pool is not big enough, then this script will be shutdown, execution will instantly stop, and the console will inform the user that they need a larger pool to continue. If a main script of a collection is shutdown as a result of calling this function, the entire collection will also be shutdown.

function RequirePoolSize(pool, size) --[[ ... ]] end

Parameters​

  • pool: string - The name of the pool to get the size of. This is case-sensitive and must match the pool name exactly. See the list of available pools.
  • size: integer - The minimum size of the pool.

Return Values​

None.

Example​

RequirePoolSize("my_pool", 10)

-- ... rest of your script