EditorBallMovementInformation Class Reference

Top level data class used to configure and serialize movement information of the bullets fired by Schmitty Doop. More...

Inheritance diagram for EditorBallMovementInformation:

Collaboration diagram for EditorBallMovementInformation:

Public Types
enum	BallMovementType {   BallMovementType.CONSTANT_SPEED, BallMovementType.DECREASE_SPEED, BallMovementType.INCREASE_SPEED, BallMovementType.SQUARE_WAVE,   BallMovementType.SINE_WAVE, BallMovementType.TRIANGLE_WAVE, BallMovementType.WHIRLY_WAVE, BallMovementType.START_STOP }
	The types of ball movements supported in serialization. New types of movement should have an entry added in this enum. More...

Public Member Functions
abstract CoopBallManager.BallMovementInitialize	GetInitializer ()
	Return the BallMovementInitializer that corresponds to the BallMovementType. More...
abstract System.Type	GetCoopBallMovementType ()
	Return the type of the BallMovementType. More...
abstract List< string >	ConvertPropertiesToStrings ()
	Convert all properties of the implementation class that should be serialized to a string. See the method ConvertPropertiesToString in the EditorActionInformation class for more information, the two methods are used for the same purpose. More...

Static Public Member Functions
static EditorBallMovementInformation	CreateEditorBallMovementInformation (BallMovementType ballMovementType, string objectString)
	Create the appropiate child movement information from the given movement type and serialized string. More...

Protected Member Functions
abstract void	FillPropertiesFromString (string objectString)
	Construct the child class based on the string that was serialized. See the method FillPropertiesFromString in the EditorActionInformation class for more information, the two methods are used for the same purpose. More...

Detailed Description

Top level data class used to configure and serialize movement information of the bullets fired by Schmitty Doop.

All data shown in the inspector and all data needed to initialize how a bullet from Schmitty Doop should move. All types of ball movements should implement this class to show data in the inspector or serialize to a file.

Member Enumeration Documentation

BallMovementType

enum EditorBallMovementInformation.BallMovementType

strong

The types of ball movements supported in serialization. New types of movement should have an entry added in this enum.

Enumerator
CONSTANT_SPEED
DECREASE_SPEED
INCREASE_SPEED
SQUARE_WAVE
SINE_WAVE
TRIANGLE_WAVE
WHIRLY_WAVE
START_STOP

Member Function Documentation

ConvertPropertiesToStrings()

abstract List<string> EditorBallMovementInformation.ConvertPropertiesToStrings ( )

pure virtual

Convert all properties of the implementation class that should be serialized to a string. See the method ConvertPropertiesToString in the EditorActionInformation class for more information, the two methods are used for the same purpose.

Returns

Each property of the child class that should be serialized.

Implemented in EditorSineWaveBallMovementInformation, EditorSquareWaveBallMovementInformation, EditorTriangleWaveBallMovementInformation, EditorWhirlyBallMovementInformation, EditorStartStopBallMovementInformation, EditorDecreaseSpeedBallMovementInformation, EditorIncreaseSpeedBallMovementInformation, and EditorConstantSpeedBallMovementInformation.

CreateEditorBallMovementInformation()

static EditorBallMovementInformation EditorBallMovementInformation.CreateEditorBallMovementInformation ( BallMovementType  ballMovementType, string  objectString  )

static

Create the appropiate child movement information from the given movement type and serialized string.

Parameters

ballMovementType	The type of ball movement object to create.
objectString	The serialized data used to create the ballMovementType. The should should be created from the CovertPropertiesToString method.

Returns

The newly created EditorBallMovementInformation

FillPropertiesFromString()

abstract void EditorBallMovementInformation.FillPropertiesFromString ( string  objectString )

protectedpure virtual

Construct the child class based on the string that was serialized. See the method FillPropertiesFromString in the EditorActionInformation class for more information, the two methods are used for the same purpose.

Parameters

The	serialized string of all the properties in this object.

Implemented in EditorSineWaveBallMovementInformation, EditorSquareWaveBallMovementInformation, EditorTriangleWaveBallMovementInformation, EditorWhirlyBallMovementInformation, EditorStartStopBallMovementInformation, EditorDecreaseSpeedBallMovementInformation, EditorIncreaseSpeedBallMovementInformation, and EditorConstantSpeedBallMovementInformation.

GetCoopBallMovementType()

abstract System.Type EditorBallMovementInformation.GetCoopBallMovementType ( )

pure virtual

Return the type of the BallMovementType.

Returns

The type of the BallMovementType.

Implemented in EditorSineWaveBallMovementInformation, EditorSquareWaveBallMovementInformation, EditorTriangleWaveBallMovementInformation, EditorWhirlyBallMovementInformation, EditorConstantSpeedBallMovementInformation, EditorStartStopBallMovementInformation, EditorDecreaseSpeedBallMovementInformation, and EditorIncreaseSpeedBallMovementInformation.

GetInitializer()

abstract CoopBallManager.BallMovementInitialize EditorBallMovementInformation.GetInitializer ( )

pure virtual

Return the BallMovementInitializer that corresponds to the BallMovementType.

Returns

The BallMovementInitializer that corresponds to the BallMovementType.

Implemented in EditorSineWaveBallMovementInformation, EditorSquareWaveBallMovementInformation, EditorTriangleWaveBallMovementInformation, EditorWhirlyBallMovementInformation, EditorConstantSpeedBallMovementInformation, EditorStartStopBallMovementInformation, EditorDecreaseSpeedBallMovementInformation, and EditorIncreaseSpeedBallMovementInformation.

---

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

• Assets/Scripts/EditorActions/EditorBallMovement/EditorBallMovementInformation.cs