Inheritance diagram for Anvil.API.Events.DoorEvents.OnAreaTransitionClick:

Collaboration diagram for Anvil.API.Events.DoorEvents.OnAreaTransitionClick:

Public Member Functions
void	SetAreaTransitionBMP (AreaTransition transition)
	Sets the graphic shown when a PC moves between two different areas in a module. More...

void	SetAreaTransitionBMP (string transition)
	Sets the graphic shown when a PC moves between two different areas in a module. More...

Properties
NwPlayer	ClickedBy = NWScript.GetClickingObject().ToNwPlayer()! `[get]`
	Gets the NwCreature that clicked the transition. More...

NwDoor	Door = NWScript.OBJECT_SELF.ToNwObject<NwDoor>()! `[get]`
	Gets the NwDoor that has the transition. More...

NwStationary	TransitionTarget = NWScript.GetTransitionTarget(NWScript.OBJECT_SELF).ToNwObject<NwStationary>()! `[get]`
	Gets the transition target for this NwDoor. More...

Properties inherited from Anvil.API.Events.IEvent
NwObject?	Context `[get]`

Member Function Documentation

◆ SetAreaTransitionBMP() [1/2]

void Anvil.API.Events.DoorEvents.OnAreaTransitionClick.SetAreaTransitionBMP ( AreaTransition transition )

inline

Sets the graphic shown when a PC moves between two different areas in a module.

Parameters

transition The transition to use.

◆ SetAreaTransitionBMP() [2/2]

void Anvil.API.Events.DoorEvents.OnAreaTransitionClick.SetAreaTransitionBMP ( string transition )

inline

Sets the graphic shown when a PC moves between two different areas in a module.

Parameters

transition The file name (.bmp) to use for the area transition bitmap.

Property Documentation

◆ ClickedBy

NwPlayer Anvil.API.Events.DoorEvents.OnAreaTransitionClick.ClickedBy = NWScript.GetClickingObject().ToNwPlayer()!

get

Gets the NwCreature that clicked the transition.

◆ Door

NwDoor Anvil.API.Events.DoorEvents.OnAreaTransitionClick.Door = NWScript.OBJECT_SELF.ToNwObject<NwDoor>()!

get

Gets the NwDoor that has the transition.

◆ TransitionTarget

NwStationary Anvil.API.Events.DoorEvents.OnAreaTransitionClick.TransitionTarget = NWScript.GetTransitionTarget(NWScript.OBJECT_SELF).ToNwObject<NwStationary>()!

get

Gets the transition target for this NwDoor.

The documentation for this class was generated from the following file:

NWN.Anvil/src/main/API/Events/Game/DoorEvents/DoorEvents.OnAreaTransitionClick.cs

Public Member Functions