HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.ZoneDesignLoadOverride Class Reference

Public Member Functions

 __init__ (self, _api.ZoneDesignLoadOverride zoneDesignLoadOverride)
 Create_ZoneDesignLoadOverride_zoneId_designLoad (int zoneId, str designLoad)
 Create_ZoneDesignLoadOverride_zoneId_designLoad_limitFactor_ultimateFactor_helpFactor_hurtFactor (int zoneId, str designLoad, float|None limitFactor, float|None ultimateFactor, float|None helpFactor, float|None hurtFactor)

Protected Attributes

 _Entity = zoneDesignLoadOverride

Properties

 DesignLoad = property
 The name of the design load to which this override applies.
 HelpFactor = property
 Get or set the help factor for this zone, design load pairing.
 HurtFactor = property
 Get or set the hurt factor for this zone, design load pairing.
 LimitFactor = property
 Get or set the limit factor for this zone, design load pairing.
 UltimateFactor = property
 Get or set the ultimate factor for this zone, design load pairing.
 ZoneId = property
 The zone ID to which this override applies.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.ZoneDesignLoadOverride.__init__ ( self,
_api.ZoneDesignLoadOverride zoneDesignLoadOverride )

Member Function Documentation

◆ Create_ZoneDesignLoadOverride_zoneId_designLoad()

hyperx.api.ZoneDesignLoadOverride.Create_ZoneDesignLoadOverride_zoneId_designLoad ( int zoneId,
str designLoad )

◆ Create_ZoneDesignLoadOverride_zoneId_designLoad_limitFactor_ultimateFactor_helpFactor_hurtFactor()

hyperx.api.ZoneDesignLoadOverride.Create_ZoneDesignLoadOverride_zoneId_designLoad_limitFactor_ultimateFactor_helpFactor_hurtFactor ( int zoneId,
str designLoad,
float | None limitFactor,
float | None ultimateFactor,
float | None helpFactor,
float | None hurtFactor )

Member Data Documentation

◆ _Entity

hyperx.api.ZoneDesignLoadOverride._Entity = zoneDesignLoadOverride
protected

Property Documentation

◆ DesignLoad

hyperx.api.ZoneDesignLoadOverride.DesignLoad = property
static

The name of the design load to which this override applies.

◆ HelpFactor

hyperx.api.ZoneDesignLoadOverride.HelpFactor = property
static

Get or set the help factor for this zone, design load pairing.

Note, changes are not immediately persisted to the database.

◆ HurtFactor

hyperx.api.ZoneDesignLoadOverride.HurtFactor = property
static

Get or set the hurt factor for this zone, design load pairing.

Note, changes are not immediately persisted to the database.

◆ LimitFactor

hyperx.api.ZoneDesignLoadOverride.LimitFactor = property
static

Get or set the limit factor for this zone, design load pairing.

Note, changes are not immediately persisted to the database.

◆ UltimateFactor

hyperx.api.ZoneDesignLoadOverride.UltimateFactor = property
static

Get or set the ultimate factor for this zone, design load pairing.

Note, changes are not immediately persisted to the database.

◆ ZoneId

hyperx.api.ZoneDesignLoadOverride.ZoneId = property
static

The zone ID to which this override applies.


The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py