previous chapter contents page top page next chapter

OrientCoupon

Inherits from Coupon
encodes empty field list;

Class Description

Class OrientCoupon is a subclass of Coupon that allows the user to change the orientation (rotation) of certain objects, such as shapes and animations. Objects of this class work by calling SetOrientation on the coupon's target.

Remember that if the documentation and the software (especially the definition files) disagree, always trust the software.

Programming information

Instantiate: rarely
Subclass: rarely
Call its methods: never

You might instantiate objects of this class if you wanted to create your own orientation coupons, and you might create subclasses if you wanted to create a coupon for a specialized kind of rotation.

Methods defined by class OrientCoupon

Class OrientCoupon defines the following methods:

Method Description
ApplyCoupon Overridden to call SetOrientation on the coupon's target.

Fields defined by class OrientCoupon

Class OrientCoupon defines no fields.

Method Descriptions

ApplyCoupon

overrides ApplyCoupon

Call: rarely
Override: sometimes

Magic Cap calls ApplyCoupon when the user drops a coupon into a viewable object. ApplyCoupon should perform the action represented by the coupon. OrientCoupon_ApplyCoupon changes the target's orientation by calling SetOrientation with the value in the coupon's selector field.