C# Class EssentialsPlugin.Essentials

Inheritance: IPlugin, IChatEventHandler, IPlayerEventHandler, ICubeGridHandler, ICubeBlockEventHandler, ISectorEventHandler

显示文件 Open project: rexxar-tc/EssentialsPlugin Class Usage Examples

Public Properties

Property	Type	Description
Log	Logger

Private Properties

Property	Type	Description
DisplayAvailableCommands	void
DoInit	void
HandleHelpCommand	void
HandleHelpDialog	void
PluginProcessing	void

Public Methods

Method	Description
HandleChatMessage ( ulong steamId, string message ) : void
Init ( ) : void
InitWithPath ( String modPath ) : void
OnChatReceived ( ChatManager obj ) : void	Raised when a chat messages are received. NOTE: This is raised on a different thread
OnChatSent ( ChatManager obj ) : void
OnCubeBlockCreated ( CubeBlockEntity entity ) : void
OnCubeBlockDeleted ( CubeBlockEntity entity ) : void
OnCubeGridCreated ( CubeGridEntity cubeGrid ) : void
OnCubeGridDeleted ( CubeGridEntity cubeGrid ) : void
OnCubeGridLoaded ( CubeGridEntity cubeGrid ) : void
OnCubeGridMoved ( CubeGridEntity cubeGrid ) : void
OnEntityAdd ( IMyEntity obj ) : void
OnEntityRemove ( IMyEntity obj ) : void
OnMessageReceived ( ) : void
OnPlayerJoined ( ulong remoteUserId ) : void
OnPlayerLeft ( ulong remoteUserId ) : void
OnPlayerWorldSent ( ulong remoteUserId ) : void
OnSectorSaved ( object state ) : void
Shutdown ( ) : void
Update ( ) : void

Private Methods

Method	Description
DisplayAvailableCommands ( ulong remoteUserId, string recvMessage ) : void	Displays the available commands for the command entered
DoInit ( string path ) : void
HandleHelpCommand ( ulong remoteUserId, IReadOnlyCollection commandParts ) : void	This function displays available help for all the functionality of this plugin
HandleHelpDialog ( ulong remoteUserId, IReadOnlyCollection commandParts ) : void	This function displays available help for all the functionality of this plugin in a dialog window
PluginProcessing ( ) : void

Method Details

HandleChatMessage() public method

public HandleChatMessage ( ulong steamId, string message ) : void
steamId	ulong
message	string
return	void

Init() public method

public Init ( ) : void
return	void

InitWithPath() public method

public InitWithPath ( String modPath ) : void
modPath	String
return	void

OnChatReceived() public method

Raised when a chat messages are received. NOTE: This is raised on a different thread

public OnChatReceived ( ChatManager obj ) : void
obj	ChatManager
return	void

OnChatSent() public method

public OnChatSent ( ChatManager obj ) : void
obj	ChatManager
return	void

OnCubeBlockCreated() public method

public OnCubeBlockCreated ( CubeBlockEntity entity ) : void
entity	CubeBlockEntity
return	void

OnCubeBlockDeleted() public method

public OnCubeBlockDeleted ( CubeBlockEntity entity ) : void
entity	CubeBlockEntity
return	void

OnCubeGridCreated() public method

public OnCubeGridCreated ( CubeGridEntity cubeGrid ) : void
cubeGrid	CubeGridEntity
return	void

OnCubeGridDeleted() public method

public OnCubeGridDeleted ( CubeGridEntity cubeGrid ) : void
cubeGrid	CubeGridEntity
return	void

OnCubeGridLoaded() public method

public OnCubeGridLoaded ( CubeGridEntity cubeGrid ) : void
cubeGrid	CubeGridEntity
return	void

OnCubeGridMoved() public method

public OnCubeGridMoved ( CubeGridEntity cubeGrid ) : void
cubeGrid	CubeGridEntity
return	void

OnEntityAdd() public method

public OnEntityAdd ( IMyEntity obj ) : void
obj	IMyEntity
return	void

OnEntityRemove() public method

public OnEntityRemove ( IMyEntity obj ) : void
obj	IMyEntity
return	void

OnMessageReceived() public method

public OnMessageReceived ( ) : void
return	void

OnPlayerJoined() public method

public OnPlayerJoined ( ulong remoteUserId ) : void
remoteUserId	ulong
return	void

OnPlayerLeft() public method

public OnPlayerLeft ( ulong remoteUserId ) : void
remoteUserId	ulong
return	void

OnPlayerWorldSent() public method

public OnPlayerWorldSent ( ulong remoteUserId ) : void
remoteUserId	ulong
return	void

OnSectorSaved() public method

public OnSectorSaved ( object state ) : void
state	object
return	void

Shutdown() public method

public Shutdown ( ) : void
return	void

Update() public method

public Update ( ) : void
return	void

Property Details

Log public_oe static_oe property

public static Logger Log
return	Logger