Sync Robots Event

Quick Facts

Property	Value
Class	`CENPyOlpSyncRobotsEvent`
Module	`cenpylib.CENPyOlpSyncRobotsEvent`
Package	`cenpylib`
Release	R2025.2.4
Methods	8
Inherits from	`CENPyOlpBuiltInEvent`


# Boilerplate Example
# Acquire the event object from the runtime context
syncRobotsEvent = ...  # provided by the framework

Method	Returns	Summary
`SetSyncMode`	`—`	Set the new synchronization mode.
`GetSyncMode`	`int`	Get the synchronization mode.
`SetRegionState`	`—`	Set the region state.
`GetRegionState`	`bool`	Get the region state.
`SetLeaderState`	`—`	Set the state of the leader flag.
`GetLeaderState`	`bool`	Get the state of the leader flag.
`SetSyncText`	`—`	Set the new synchronization text.
`GetSyncText`	`str`	Get the synchronization text


def GetSyncMode() -> int

Get the synchronization mode.

Returns: int — Synchronization mode.


def GetRegionState() -> bool

Get the region state.

Returns: bool — Region state.


def GetLeaderState() -> bool

Get the state of the leader flag.

Returns: bool — State of the leader flag.


def GetSyncText() -> str

Get the synchronization text

Returns: str — Synchronization text.


def SetSyncMode(syncMode: int)

Set the new synchronization mode.

Parameters:

Name	Type	Description
`syncMode`	`int`	New synchronization mode.


def SetRegionState(state: bool)

Set the region state.

Parameters:

Name	Type	Description
`state`	`bool`	New region state.


def SetLeaderState(isLeader: bool)

Set the state of the leader flag.

Parameters:

Name	Type	Description
`isLeader`	`bool`	New leader state flag.


def SetSyncText(syncText: str)

Set the new synchronization text.

Parameters:

Name	Type	Description
`syncText`	`str`	New synchronization text.

This class is documented as of release R2025.2.4.

Was this page helpful?