GBBopen 1.5 Reference -- reset-unit-class

reset-unit-class

reset-unit-class

unit-class-or-name

[Generic Function]

Purpose
Resets the unit-class instance-name counter of unit-class to its initial value.

Method signatures

reset-unit-class (unit-class-name symbol)

reset-unit-class (unit-class-specifier cons)

reset-unit-class (unit-class standard-unit-instance)

Package :gbbopen

Module :gbbopen-core

Arguments and values

unit-class

A unit class

Description
The unit-class instance-name counter of unit-class is reset to the value returned by calling initial-class-instance-number with unit-class, but only if the unit class is not abstract, if the :use-global-instance-name-counter class option is nil or was not specified for the unit class, and if there are no existing instances of that class. If instances do exist and the global instance-name counter is not being used for the unit class, a warning is issued.

Example
Reset the instance-name counters of all unit classes:

  > (reset-unit-class 't)
  ;; Warning: Unit class standard-space-instance has 4 instances; not reset
  >

Note that a warning was issued when resetting standard-space-instance because 4 space instances of that class exist.

The GBBopen Project

reset-unit-class