rs3.properties.stageFactors.StageFactorInterfaces module#

class rs3.properties.stageFactors.StageFactorInterfaces.AbsoluteStageFactorInterface(propertyID: str, client: Client, definedStageFactorClass, stageFactorClass, useJointOptions: bool = False, materialId: str = None)#

Bases: AbsoluteStageFactorInterface[DefinedStageFactor, StageFactor]

createStageFactor(stage: int) → DefinedStageFactor#

Creates a stage factor for the given stage.

Note

Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.

setDefinedStageFactors(stageFactors: dict[int, StageFactor])#

Sets the defined stage factors to those given.

Note

Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.

getStageFactorMethod() → StageFactorMethodType#

Returns the method used when defining stage factors.

class rs3.properties.stageFactors.StageFactorInterfaces.RelativeStageFactorInterface(propertyID: str, client: Client, definedStageFactorClass, stageFactorClass)#

Bases: AbsoluteStageFactorInterface[DefinedStageFactor, StageFactor]

setDefinedStageFactors(method: StageFactorMethodType, stageFactors: dict[int, StageFactor])#

Sets the defined stage factors to those given. The method indicates if the stages in the keys of the map are absolute or relative.

Note

  • Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.

  • If the ‘stageFactors’ dictionary is empty (stageFactors = {}), the stage factor at the installed stage (stage 0) will remain, and its factor values will be reset to their defaults.

getStageFactorMethod() → StageFactorMethodType#

Returns the method used when defining stage factors.