Skip to content

clone_sync ​

Observe incoming clone events and register session-scoped filters.

These APIs attach to Harmony's existing verified receive paths. They expose fixed incoming filters and deferred observations. They do not expose packet sending, a live node mutation interface, or Lua execution inside a network hook.

Clone API ​

clone_sync.available ​

Whether verified clone/sync bindings are available.

text
clone_sync.available()

Returns: Boolean

clone_sync.remove_available ​

Whether the separate removal binding is available.

text
clone_sync.remove_available()

Returns: Boolean

clone_sync.block_create ​

Registers an incoming create filter.

text
clone_sync.block_create(filter)

Returns: RuleId

clone_sync.block_sync ​

Registers an incoming sync filter.

text
clone_sync.block_sync(filter)

Returns: RuleId

clone_sync.block_remove ​

Registers an incoming removal filter; requires removal support.

text
clone_sync.block_remove(filter)

Returns: RuleId

clone_sync.unblock ​

Removes a matching rule owned by this script; missing/foreign IDs have no effect.

text
clone_sync.unblock(rule_id)

Returns: Nothing

clone_sync.on_event ​

Sets this script's single clone observer, replacing the previous callback.

text
clone_sync.on_event(callback)

Returns: Nothing

clone_sync.dropped_events ​

Shared clone/node observation-queue overflow counter, not a per-script count.

text
clone_sync.dropped_events()

Returns: Integer

clone_sync.object_type ​

Named object-type constants listed below.

text
clone_sync.object_type

Returns: Table

Object-type constants ​

Access these as clone_sync.object_type.Name. Count is not an exported member.

ValueNameValueName
0Animal15DraftVehicle
1Automobile16StatsTracker
2Bike17PropSet
3Boat18AnimScene
4Door19GroupScenario
5Heli20Herd
6Object21Horse
7Ped22WorldState
8Pickup23WorldProjectile
9PickupPlacement24Incident
10Plane25GuardZone
11Submarine26PedGroup
12Player27CombatDirector
13Trailer28PedSharedTargeting
14Train29Persistent