KSP API
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties
Public Member Functions | Public Attributes | List of all members
EventReport Class Reference

A type frequently used as a parameter in GameEvents More...

Public Member Functions

 EventReport (FlightEvents type, Part eventCreator, string name="an unidentified object", string otherName="an unidentified object", int stageNumber=0, string customMsg="")
 The EventReport constructor, generally used when firing an EventData event that calls for an EventReport parameter More...
 

Public Attributes

FlightEvents eventType
 An enum used to specify the type of EventReport; see FlightEvents for the available types More...
 
string msg
 A string message that can accompany the EventReport More...
 
Part origin
 The Part responsible for generating the EventReport More...
 
string other
 Usually the originating part name More...
 
string sender
 The target of the event; another part's name, the surface, blank, etc... More...
 
int stage
 The active stage number when the EventReport is generated; can be set to any integer; 0 by default More...
 

Detailed Description

A type frequently used as a parameter in GameEvents

Constructor & Destructor Documentation

EventReport.EventReport ( FlightEvents  type,
Part  eventCreator,
string  name = "an unidentified object",
string  otherName = "an unidentified object",
int  stageNumber = 0,
string  customMsg = "" 
)

The EventReport constructor, generally used when firing an EventData event that calls for an EventReport parameter

someEvent.Fire(new EventReport(...));

Parameters
type
eventCreator
name
otherName
stageNumber
customMsg

Member Data Documentation

FlightEvents EventReport.eventType

An enum used to specify the type of EventReport; see FlightEvents for the available types

string EventReport.msg

A string message that can accompany the EventReport

Part EventReport.origin

The Part responsible for generating the EventReport

string EventReport.other

Usually the originating part name

string EventReport.sender

The target of the event; another part's name, the surface, blank, etc...

int EventReport.stage

The active stage number when the EventReport is generated; can be set to any integer; 0 by default


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