Class AcDbSysVarManager

Readonlyevents

applyVarMutation

• applyVarMutation<T>(
      name: string,
      oldVal: T,
      newVal: T,
      db: AcDbDatabase,
      mutate: () => void,
  ): void

• Applies one system variable mutation with shared transaction and event rules.

  Database-backed variables should mutate through AcDbDatabase property setters or setVar. Non-database variables mutate through the cache.

  Type Parameters

  • T

  Parameters

  • name: string

    System variable name (normalized internally)
  • oldVal: T

    Value before mutation; recorded for undo when a transaction is active
  • newVal: T

    Value after mutation; used for change detection and event dispatch
  • db: AcDbDatabase

    Database whose transaction manager governs recording and strict mode
  • mutate: () => void

    Callback that performs the actual value write

  Returns void

getAllDescriptors

• getAllDescriptors(): AcDbSysVarDescriptor[]

• Get all registered system variable descriptors.

  Returns AcDbSysVarDescriptor[]

getDefaultValue

• getDefaultValue(name: string): undefined | AcDbSysVarType

• Get system variable default value.

  Parameters

  • name: string

  Returns undefined | AcDbSysVarType

getDescriptor

• getDescriptor(name: string): undefined | AcDbSysVarDescriptor

• Get system variable metadata descriptor (if registered).

  Parameters

  • name: string

  Returns undefined | AcDbSysVarDescriptor

getVar

• getVar(name: string, db: AcDbDatabase): undefined | AcDbSysVarType

• Get system variable value.

  Parameters

  • name: string
  • db: AcDbDatabase

  Returns undefined | AcDbSysVarType

registerMany

• registerMany(vars: AcDbSysVarDescriptor[]): void

• Register many system variables.

  Parameters

  • vars: AcDbSysVarDescriptor[]

  Returns void

registerVar

• registerVar(desc: AcDbSysVarDescriptor): void

• Register one system variable metadata entry.

  Parameters

  • desc: AcDbSysVarDescriptor

  Returns void

setLoginName

• setLoginName(value: string): void

• Initializes the session AcDbSystemVariables.LOGINNAME value.

  setVar rejects writes because LOGINNAME is read-only for users; host applications call this once at startup (for example after auth).

  Parameters

  • value: string

    Login / user display name.

  Returns void

setVar

• setVar(name: string, value: AcDbSysVarType, db: AcDbDatabase): void

• Set system variable value.

  Parameters

  • name: string
  • value: AcDbSysVarType
  • db: AcDbDatabase

  Returns void

Staticinstance

• instance(): AcDbSysVarManager

• Singleton accessor

  Returns AcDbSysVarManager