GetLinkedRef

From GECK
Jump to: navigation, search


A function included in the GECK for Fallout 3.

Description

GetLinkedRef gives the reference that is currently linked to the current reference. For example, if a switch opens a door, you can link the switch to the door and if the switch is activated you get the door reference and activate it. It is called on a reference and takes no parameters.

Syntax

[help]
(reference) reference.GetLinkedRef

Example

scn SwitchScript

ref MyMarker 

Begin OnActivate

Set MyMarker to GetLinkedRef

    if MyMarker.GetDisabled == 0 ;if marker is enabled...
         PlaySound OBJSwitchButtonB
         MyMarker.Disable

else
         PlaySound OBJSwitchButtonA
         MyMarker.Enable

endif
end

A simple, completed example of a switch script that uses GetLinkedRef.

The activator that will hold this script should have an enable parent added to it as its linked ref.

See Also