[Placebo Effect] >[Programming]>[CodeRally]

CodeRally 1.1.1 APIリファレンス非公式日本語訳

2004-09-05 Yutaka Kachi

今更ですが、Car.javaから作成したjavadocを元に、メモ的な日本語訳を作ってみました。
これだけ読んでもラリーカーの作り方はよくわからないと思うので、他の資料も当たってね。

クラス Car

public abstract class Car

Carクラスは、CodeRallyの中心となるクラスです。
このクラスを継承して、あなたのラリーカーRallyCarクラスを作ります。
このクラスは、いくつかのフィールドとメソッドを持っています。
メソッドは、ラリーカーの状況を調べたり動作させるために使います。

■ フィールド

Carクラスは、いくつかのフィールドを持っています。すべてstaticになっており定数として扱います。
Car_という名前がついているフィールドは、ラリーカーの色を設定するために使います。
MAX_およびMIN_という名前がついているフィールドは、ラリーカーの設定で最大値/最小値をするものです。

使用例

　ラリーカーの色を青色に設定します

   public byte getColor() {
       return CAR_BLUE;
   }

　スロットルを最大に設定します

   public void move(int lastMoveTime, boolean hitWall, ICar collidedWithCar, ICar hitBySpareTire) {
       setThrottle(MAX_THROTTLE);
   }

CAR_BLUE

分類:フィールド所属:Carクラス
static byte CAR_BLUE

　ラリーカーの色を青に設定します

CAR_ORANGE

分類:フィールド所属:Carクラス
static byte CAR_ORANGE

　ラリーカーの色をオレンジに設定します

CAR_PURPLE

分類:フィールド所属:Carクラス
static byte CAR_PURPLE

　ラリーカーの色をムラサキに設定します

CAR_RED

分類:フィールド所属:Carクラス
static byte CAR_RED

　ラリーカーの色を赤色に設定します

CAR_TEAL

分類:フィールド所属:Carクラス
static byte CAR_TEAL

　ラリーカーの色を青緑に設定します

CAR_YELLOW

分類:フィールド所属:Carクラス
static byte CAR_YELLOW

　ラリーカーの色を黄色に設定します

MAX_CLOCK_TICKS

分類:フィールド所属:Carクラス
static int MAX_CLOCK_TICKS

　競技の1ステージの時間(600tick)

MAX_FUEL

分類:フィールド所属:Carクラス
static int MAX_FUEL

　ラリーカーに搭載できる燃料の最大値(100)

MAX_STEER_LEFT

分類:フィールド所属:Carクラス
static int MAX_STEER_LEFT

　ラリーカーのステアリングを左に回す際の最大値(-10°)。
　setSteeringメソッドにこの値を設定すると、ラリーカーは左に進みます。

MAX_STEER_RIGHT

分類:フィールド所属:Carクラス
static int MAX_STEER_RIGHT

　ラリーカーのステアリングを右に回す際の最大値(10°)。
　setSteeringメソッドにこの値を設定すると、ラリーカーは右に進みます。

MAX_THROTTLE

分類:フィールド所属:Carクラス
static int MAX_THROTTLE

　ラリーカーのスロットルの最大値(100)。
　setThrottleメソッドにこの値を設定すると、ラリーカーは前進します。

MIN_FUEL

分類:フィールド所属:Carクラス
static int MIN_FUEL

　ラリーカーに搭載できる燃料の最少値(0)

MIN_THROTTLE

分類:フィールド所属:Carクラス
static int MIN_THROTTLE

　ラリーカーのスロットルの最少値(-50)。
　setThrottleメソッドにこの値を設定すると、ラリーカーは後退します。

メソッド

　ここでは、Carクラスのメソッドの詳細を説明します。

enterProtectMode()

分類:メソッド所属:Carクラス
boolean enterProtectMode()

プロテクトモードに移行します。
プロテクトモードは、50tick持続し、他車やタイヤ攻撃から身を守ることができます。
ただし、ガソリンの消費量は2倍になります。

getChangeInHeading()

分類:メソッド所属:Carクラス

int getChangeInHeading()

　進行方向の角度の変化率を得ます。
　戻り値は、360度法で示されます。

getCheckpoints()

分類:メソッド所属:Carクラス
IObject[] getCheckpoints()

　すべてのチェックポイントの情報を得ます。
　戻り値は、IObjectオブジェクトの配列になります。
　さらに詳しい情報を得るには、このIObjectオブジェクトのメソッドを呼び出します。

関連
IObject

getClockTicks()

分類:メソッド所属:Carクラス
int getClockTicks()

　進行中の競技について、現在時刻を得ます。
　戻り値は、tickという単位になります。

getColor()

分類:メソッド所属:Carクラス
abstract byte getColor()

　自分のラリーカーの色を設定します。

getDistanceTo(double x, double y)

分類:メソッド所属:Carクラス
double getDistanceTo(double x, double y)

　x,y座標を指定すると、現在位置からそこまでの直線距離を教えてくれます。

getDistanceTo(IObject obj)

分類:メソッド所属:Carクラス
double getDistanceTo(IObject obj)

　IObjectオブジェクトを指定すると、現在位置からそこまでの直線距離を教えてくれます。

getFuel()

分類:メソッド所属:Carクラス
int getFuel()

　残りのガソリンの量を教えてくれます。

getFuelDepots()

分類:メソッド所属:Carクラス
IObject[] getFuelDepots()

　すべてのガスステーションの情報を得ます。
　戻り値は、IObjectオブジェクトの配列になります。
　さらに詳しい情報を得るには、配列のメソッドかIObjectオブジェクトのメソッドを呼び出します。

関連
IObject

getHeading()

分類:メソッド所属:Carクラス
int getHeading()

　現在のラリーカーの進行方向を得ます。
　戻り値は、360度法で示されます。

getHeadingTo(double x, double y)

分類:メソッド所属:Carクラス
int getHeadingTo(double x, double y)

　x,y座標を指定すると、現在位置からそこまでの絶対角度を教えてくれます。
　戻り値は、360度法で示されます。

getHeadingTo(IObject obj)

分類:メソッド所属:Carクラス
int getHeadingTo(IObject obj)

　IObjectオブジェクトを指定すると、現在位置からそこまでの絶対角度を教えてくれます。
　戻り値は、360度法で示されます。

getName()

分類:メソッド所属:Carクラス
abstract java.lang.String getName()

　自分のラリーカーの名前を設定します。

getNumberOfSpareTires()

分類:メソッド所属:Carクラス
int getNumberOfSpareTires()

　自分のラリーカーに積んでいるスペアータイヤ数を教えてくれます。

getOpponents()

分類:メソッド所属:Carクラス
ICar[] getOpponents()

　競技に参加している対向車の情報を得ます。
　戻り値は、ICarオブジェクトの配列になります。
　さらに詳しい情報を得るには、配列のメソッドかICarオブジェクトのメソッドを呼び出します。

関連
ICar

getPoints()

分類:メソッド所属:Carクラス
int getPoints()

　自分のラリーカーの得点を得ます。

getPreviousCheckpoint()

分類:メソッド所属:Carクラス
int getPreviousCheckpoint()

　ひとつ前に通過したチェックポイントの番号を得ます。
　-1になったときは、まだどのチェックポイントも通過していません。

getSchoolName()

分類:メソッド所属:Carクラス
abstract java.lang.String getSchoolName()

　自分の学校名を、チーム名として設定します。

getSpareTireDepot()

分類:メソッド所属:Carクラス
IObject[] getSpareTireDepot()

　すべてのタイヤ補給所の情報を得ます。
　戻り値は、IObjectオブジェクトの配列になります。
　さらに詳しい情報を得るには、配列のメソッドかIObjectオブジェクトのメソッドを呼び出します。

関連
IObject

getSpareTiresOnTrack()

分類:メソッド所属:Carクラス
ISpareTire[] getSpareTiresOnTrack()

　投げたスペアタイヤの情報を得ます。
　戻り値は、ISpareTireオブジェクトの配列になります。
　さらに詳しい情報を得るには、配列のメソッドかISpareTireオブジェクトのメソッドを呼び出します。

関連
ISpareTire

getSpeed()

分類:メソッド所属:Carクラス
double getSpeed()

　自分のラリーカーの現在速度を得ます。

getSteeringSetting()

分類:メソッド所属:Carクラス
int getSteeringSetting()

　現在のステアリング角度を得ます。

getThrottle()

分類:メソッド所属:Carクラス
int getThrottle()

　現在のスロットルの設定値を得ます。

getTrackHeight()

分類:メソッド所属:Carクラス
int getTrackHeight()

　競技場の高さを得ます。

getTrackWidth()

分類:メソッド所属:Carクラス
int getTrackWidth()

　競技場の幅を得ます。

getX()

分類:メソッド所属:Carクラス
double getX()

　現在位置のX座標を得ます。
　原点は、競技場の左上コーナーです。

getY()

分類:メソッド所属:Carクラス
double getY()

　現在位置のY座標を得ます。
　原点は、競技場の左上コーナーです。

initialize()

分類:メソッド所属:Carクラス
abstract void initialize()

　競技開始時、ラリーカーを初期化するため呼び出されます。

isHeadlightsOn()

分類:メソッド所属:Carクラス
boolean isHeadlightsOn()

　ラリーカーのヘッドライトの状態を得ます。
　点灯時に、trueになります。

isInProtectMode()

分類:メソッド所属:Carクラス
boolean isInProtectMode()

　プロテクトモードになっているとき、trueになります。

isReadyToThrowSpareTire()

分類:メソッド所属:Carクラス
boolean isReadyToThrowSpareTire()

　スペアタイヤが投げられるとき、trueになります。
　スペアタイヤを持っていないか、まだ投げられないときにfalseになります。
　スペアタイヤを投げると、25tickの間、次のタイヤを投げられません。

move(int lastMoveTime, boolean hitWall, ICar collidedWithCar, ICar hitBySpareTire)

分類:メソッド所属:Carクラス
abstract void move(int lastMoveTime, boolean hitWall, ICar collidedWithCar, ICar hitBySpareTire)

　ラリーカーを移動するために毎tick呼び出されます。
　このメソッドは、500ミリ秒以内に完了する必要があります。
　引数として、前回の状態を得ることができます。
　衝突した他のラリーカーと、スペアタイヤをぶつけてたラリーカーの情報は、ICarオブジェクトとして与えられます。
　さらに詳しい情報を知るには、ICarオブジェクトのメソッドで調べます。

引数

int lastMoveTime	前回のmoveメソッドに何秒かかったか
boolean hitWall	壁に衝突したか
ICar collidedWithCar	衝突した他のラリーカーの情報
ICar hitBySpareTire	スペアタイヤをぶつけたラリーカーの情報

setHeadlightsOn()

分類:メソッド   所属:Carクラス
void    setHeadlightsOn(boolean on)

　ラリーカーのヘッドライトを点灯/消灯します。

引数
   true = 点灯
   false = 消灯

setSteeringSetting(int steering)

分類:メソッド   所属:Carクラス
void    setSteeringSetting(int steering)

　ラリーカーのステアリングを設定します。

引数
   MAX_STEER_LEFT(-10°) ～ MAX_STEER_RIGHT(10°)

setThrottle(int throttle)

分類:メソッド   所属:Carクラス
void    setThrottle(int throttle)

　ラリーカーのスロットルを設定します。

引数
   MIN_THROTTLE(-50) ～ MAX_THROTTLE(100)

throwSpareTire()

分類:メソッド所属:Carクラス
boolean throwSpareTire()

　スペアタイヤをラリーカーの進行方向に投げます。

■■インターフェース

Carクラスのメソッドの戻り値オブジェクトは、次のようなインターフェースを実装しています。
これらのオブジェクトは、次のメソッドを使用できます。各メソッドの詳細は、Carクラスを参照してください。

IObject

double    getDistanceTo(double x, double y)
double    getDistanceTo(IObject obj)
int    getHeadingTo(double x, double y)
int    getHeadingTo(IObject obj)
double    getX()
double    getY()

ICar

int    getChangeInHeading()
int    getFuel()
int    getHeading()
java.lang.String    getName()
int    getNumberOfSpareTires()
int    getPoints()
java.lang.String    getSchoolName()
double    getSpeed()
boolean    isInProtectMode()

**IObjectインターフェースのメソッドも使用できます

ISpareTire

int getHeading()
double getSpeed()

**IObjectインターフェースのメソッドも使用できます

CodeRally 1.1.1 APIリファレンス 非公式日本語訳