Difference between revisions of "GetLinkedRef"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)Functions\]\] +Category:\1Functions\nCategory:\1Functions (GECK 1.0))) |
imported>Jokerine m (Added completed script.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
=='''Description'''== | =='''Description'''== | ||
'''GetLinkedRef ''' | '''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'''== | =='''Syntax'''== | ||
| Line 9: | Line 9: | ||
=='''Examples'''== | =='''Examples'''== | ||
A simple, completed example of a switch script that uses '''GetLinkedRef''' is below. | |||
== | The [[activator]] that will hold this script should have an [[Reference#Enable_Parent|enable parent]] added to it as its [[Reference#Linked_Ref|linked ref]]. | ||
<pre>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</pre> | |||
=='''See Also'''== | =='''See Also'''== | ||
*[[Reference]] | |||
*[[GetDisabled]] | |||
*[[Disable]] | |||
*[[Enable]] | |||
<!-- [[GetLinkedRef _Reference|List of functions that use GetLinkedRef ]] (wiki) --> | <!-- [[GetLinkedRef _Reference|List of functions that use GetLinkedRef ]] (wiki) --> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Functions (GECK 1. | [[Category:Functions (GECK 1.1)]] | ||
[[Category:Condition Functions]] | [[Category:Condition Functions]] | ||
[[Category:Condition Functions (GECK 1. | [[Category:Condition Functions (GECK 1.1)]] | ||
[[Category:Reference Variable Functions]] | [[Category:Reference Variable Functions]] | ||
[[Category:Reference Variable Functions (GECK 1. | [[Category:Reference Variable Functions (GECK 1.1)]] | ||
Latest revision as of 02:13, 13 March 2017
Description[edit | edit source]
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[edit | edit source]
[ObjectREF.]GetLinkedRef
Examples[edit | edit source]
A simple, completed example of a switch script that uses GetLinkedRef is below.
The activator that will hold this script should have an enable parent added to it as its linked ref.
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