Struct TickConfig 

pub struct TickConfig {
    pub sa_mp: bool,
    pub omp: bool,
    pub omp_interval: Duration,
}

Tells the SDK how often SampPlugin::on_tick should fire on each server.

The two servers schedule periodic callbacks differently:

• SA-MP exports ProcessTick. The server’s main loop invokes it on every iteration — the cadence is whatever the server is configured for. The SDK has no say over the interval; the sa_mp flag only decides whether the export is advertised at all.
• native Open Multiplayer has no built-in ProcessTick equivalent. The SDK installs a repeating timer on the server’s ITimersComponent in on_ready and dispatches the timeout into on_tick. The interval is the omp_interval field.

Fields

sa_mp: bool

Enable the tick on SA-MP. When false, the plugin does not advertise Supports::PROCESS_TICK and the export becomes inert.

omp: bool

Enable the tick on native Open Multiplayer. When false, the SDK does not create the ITimersComponent timer in on_ready.

omp_interval: Duration

Interval the SDK uses when creating the Open Multiplayer timer. Ignored when omp is false. Ignored entirely on SA-MP (the server controls the cadence).

Implementations

impl TickConfig

pub fn new() -> Self

Equivalent to TickConfig::default().

pub fn sa_mp(self, enabled: bool) -> Self

Builder: sets sa_mp.

pub fn omp(self, enabled: bool) -> Self

Builder: sets omp.

pub fn omp_interval(self, interval: Duration) -> Self

Builder: sets omp_interval.

pub fn sa_mp_only() -> Self

Shortcut: tick only on SA-MP. Equivalent to TickConfig::new().omp(false).

Use when the plugin has no meaningful work to do on the Open Multiplayer tick — for example, a pure SA-MP plugin running in legacy mode under Open Multiplayer.

pub fn omp_only(interval: Duration) -> Self

Shortcut: tick only on native Open Multiplayer, at the supplied interval. Equivalent to TickConfig::new().sa_mp(false).omp_interval(interval).

Use when the plugin needs a controlled cadence specifically on Open Multiplayer and should stay silent on SA-MP — for example, a component that drives a long-poll loop only meaningful when the component API is reachable.

Trait Implementations

impl Clone for TickConfig

fn clone(&self) -> TickConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TickConfig

impl Debug for TickConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TickConfig

fn default() -> Self

Default: enabled on both servers, 5 ms timer on Open Multiplayer.