Rules
forge.propclassSince Forge API 1
Signaturepython
forge.prop.Rules(*,kind: str = 'rules',note: str | None = None,daily_loss: DailyLoss | None = None,max_loss: MaxLoss | None = None,phases: tuple[Phase, ...] = (),min_days: int | None = None,day_counts_if: str = 'trade_closed',inactivity_days: int | None = None,consistency: BestDay | None = None,max_lots: float | None = None,scaling: Scaling | None = None,bans: tuple[_Ban, ...] = (),on_breach: str | None = None,warn_at: float = 0.8) -> NoneCustom prop-firm rules, as the class attribute prop = fg.prop.Rules(...).
Parameters
| Name | Type | Default |
|---|---|---|
| kind | str | 'rules' |
| note | str | None | None |
| daily_loss | DailyLoss | None | None |
| max_loss | MaxLoss | None | None |
| phases | tuple[Phase, ...] | () |
| min_days | int | None | None |
| day_counts_if | str | 'trade_closed' |
| inactivity_days | int | None | None |
| consistency | BestDay | None | None |
| max_lots | float | None | None |
| scaling | Scaling | None | None |
| bans | tuple[_Ban, ...] | () |
| on_breach | str | None | None |
| warn_at | float | 0.8 |
warn_at is when on_prop_warning fires: the share of a rule's room, as it was when the
rule's period began, that is gone. A preset warns at 0.8.