Door Class Reference

The Door BaseType has built in functionality for handling open/closed state, and rotating one or two physical doors to match state. More...

Public Member Functions
void	Open (Context instigator, bool forward)
	Open the door.
void	OpenFromUser (Context instigator)
	Open the door. The direction the door will open depends on the instigator's relative position to the door. (if the door setup allows that direction)
void	ToggleOpenFromUser (Context instigator)
	Toggle door open or closed. If opening, the direction the door will open depends on the instigator player's relative position to the door. (if the door setup allows that direction)
void	Close (Context instigator)
	Closes the door.

Detailed Description

The Door BaseType has built in functionality for handling open/closed state, and rotating one or two physical doors to match state.

Member Function Documentation

Close()

void Close

(

Context

instigator

)

Closes the door.

Parameters

instigator

The source context that is triggering this change

Open()

void Open	(	Context	instigator,
		bool	forward )

Open the door.

Parameters

instigator	The source context triggering this change
forward	Should it open in the forward direction? Not all setups will allow bidirectional opening

OpenFromUser()

void OpenFromUser

(

Context

instigator

)

Open the door. The direction the door will open depends on the instigator's relative position to the door. (if the door setup allows that direction)

Parameters

instigator

The source context that is triggering this change

ToggleOpenFromUser()

void ToggleOpenFromUser

(

Context

instigator

)

Toggle door open or closed. If opening, the direction the door will open depends on the instigator player's relative position to the door. (if the door setup allows that direction)

Parameters

instigator

The source context that is triggering this change