buddy_subscription Property
This is a list of the subscription status for the buddy.
Syntax
def get_buddy_subscription(buddy_index: int) -> int: ...
Default Value
0
Remarks
This is a list of the subscription status for the buddy.
After a on_sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:
stNone (0) | no subscription |
stTo (1) | the buddy has a subscription to this entity. |
stFrom (2) | this entity has a subscription to the buddy |
stBoth (3) | subscription is both to and from |
stRemove (4) | the item is to be removed from the list |
The buddy_index parameter specifies the index of the item in the array. The size of the array is controlled by the buddy_count property.
This property is read-only.