RandomNumber.java

/*
 * JSwiff is an open source Java API for Macromedia Flash file generation
 * and manipulation
 *
 * Copyright (C) 2004-2005 Ralf Terdic (contact@jswiff.com)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.jswiff.swfrecords.actions;

/**
 * <p>
 * Calculates a random non-negative integer less than a specified maximum
 * number. Deprecated since SWF 5, use <code>Math.random()</code> instead.
 * </p>
 * 
 * <p>
 * Performed stack operations:<br>
 * <code>pop max</code><br>
 * <code>push rand</code> (random number in the range [0, max) )
 * </p>
 * 
 * <p>
 * ActionScript equivalent: <code>random()</code>
 * </p>
 *
 * @since SWF 4
 */
public final class RandomNumber extends Action {
  /**
   * Creates a new RandomNumber action.
   */
  public RandomNumber() {
    code = ActionConstants.RANDOM_NUMBER;
  }

  /**
   * Returns a short description of this action.
   *
   * @return <code>"RandomNumber"</code>
   */
  public String toString() {
    return "RandomNumber";
  }
}