C# Class TShockAPI.DB.WarpManager

Show file Open project: NyxStudios/TShock Class Usage Examples

Public Properties

Property	Type	Description
Warps	List

Public Methods

Method	Description
Add ( int x, int y, string name ) : bool	Adds a warp.
Find ( string warpName ) : Warp	Finds the warp with the given name.
Hide ( string warpName, bool state ) : bool	Sets the hidden state of a warp.
Position ( string warpName, int x, int y ) : bool	Sets the position of a warp.
ReloadWarps ( ) : void	Reloads all warps.
Remove ( string warpName ) : bool	Removes a warp.

Private Methods

Method	Description
FindWarp ( string warpName ) : Warp
WarpManager ( IDbConnection db ) : System

Method Details

Add() public method

Adds a warp.

public Add ( int x, int y, string name ) : bool
x	int	The X position.
y	int	The Y position.
name	string	The name.
return	bool

Find() public method

Finds the warp with the given name.

public Find ( string warpName ) : Warp
warpName	string	The name.
return	Warp

Hide() public method

Sets the hidden state of a warp.

public Hide ( string warpName, bool state ) : bool
warpName	string	The warp name.
state	bool	The state.
return	bool

Position() public method

Sets the position of a warp.

public Position ( string warpName, int x, int y ) : bool
warpName	string	The warp name.
x	int	The X position.
y	int	The Y position.
return	bool

ReloadWarps() public method

Reloads all warps.

public ReloadWarps ( ) : void
return	void

Remove() public method

Removes a warp.

public Remove ( string warpName ) : bool
warpName	string	The warp name.
return	bool

Property Details

Warps public property

The list of warps.

public List Warps
return	List