commLink object | query.t[728]

A commLink is a Special that establishes a communications link between the player character and one or more actors in remote locations.

To activate the commLink with another actor, call commLink.connectTo(other). To make it a video link as well as an audio link, call commLink.connectTo(other, true).

To disconnect the call with a specific actor, call commLink.disconnectFrom(other); to terminate the commLink with all actors, call commLink.disconnect()

`commLink : Special`

Superclass Tree (in declaration order)

`commLink`
`Special`
`object`

Summary of Properties

`active connectionList priority`

Inherited from `Special` :
`all allActive_`

Summary of Methods

`canHear canSee canTalkTo connectTo disconnect disconnectFrom isConnectedTo scopeList`

Inherited from `Special` :
`allActive classInit first next`

Properties

`active` OVERRIDDEN | `query.t[831]`

This Special is active is there's anything in its connectionList.

`connectionList` | `query.t[828]`

The list of actors we're currently connected to. This is a list of two element lists in the form [actor, video], where actor is the actor we're connected to and video is true or nil according to whether the link to that actor is a video link as well as an audio link.

`priority` OVERRIDDEN | `query.t[906]`

Give this Special a higher priority that the QSenseRegion Special so that it takes precedence when its active.

Methods

`canHear (a, b)` | `query.t[746]`

We can hear an actor if s/he's in our connection list

`canSee (a, b)` | `query.t[771]`

Otherwise use the next special.

`canTalkTo (a, b)` | `query.t[797]`

Otherwise use the next special.

`connectTo (other, video, =, nil)` | `query.t[837]`

Connect this comms link to other; if video is specified and is true, the comms links is also a video link.

`disconnect ( )` | `query.t[859]`

Disconnect this commLink from everyone

`disconnectFrom (lst)` | `query.t[872]`

Disconnect this commLink from lst, where lst may be a single actor or a list of actors.

`isConnectedTo (obj)` | `query.t[892]`

Is there a communications link with obj? Return nil if there is none, AudioLink if there's an audio connection only and VideoLink if there's a video connection as well.

`scopeList (actor)` | `query.t[734]`

Our scope list must include all the actors we're currently connected to.

Adv3Lite Library Reference Manual
Generated on 02/05/2024 from adv3Lite version 2.0