eventOnGainLOS(ActorakViewer, ObjectReferenceakTarget)
Description
Wiki Description
Event called when a viewer goes from not seeing the target, to seeing the target - if this active magic effect/alias/form is registered for it.
Documentation Comment
LOS event, sent whenever the viewer first sees the target (after registering)
Caveats
CK Wiki - Notes
- Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
- This event is not relayed to any aliases or magic effects attached to the form.
Parameters
Examples
Function SomeFunction()
RegisterForSingleLOSGain(Game.GetPlayer(), SecretDocuments) ; Before we can use OnGainLOS we must register.
EndFunction
Event OnGainLOS(Actor akViewer, ObjectReference akTarget)
;/ If other registrations had been done, we would want to check the viewer and target
But since we only registered for one we know what it is
Since we only did single los gain, we'll only get this once /;
Debug.Trace("Player just saw the documents!")
endEventAuto-Generated Example
Scriptname MyCoolScript extends Form
event OnGainLOS(Actor akViewer, ObjectReference akTarget)
Debug.trace("Event received - OnGainLOS: akViewer = " + akViewer + " akTarget = " + akTarget)
endEventRelated Pages
- ActiveMagicEffect
- Alias
- Form
- Form.RegisterForLOS(...)
- Form.RegisterForSingleLOSGain(...)
- Form.RegisterForSingleLOSLost(...)
- Form.UnregisterForLOS(...)
- Form.OnLostLOS(...)
- Actor.HasLOS(...)