com.bladecoder.engine.actions.TransitionAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blade-engine Show documentation

Classic point and click adventure game engine

There is a newer version: 4.3.1

/*******************************************************************************
 * Copyright 2014 Rafael Garcia Moreno.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package com.bladecoder.engine.actions;

import com.badlogic.gdx.graphics.Color;
import com.bladecoder.engine.actions.Param.Type;
import com.bladecoder.engine.model.Transition;
import com.bladecoder.engine.model.VerbRunner;
import com.bladecoder.engine.model.World;

@ActionDescription("Sets a transition effect (FADEIN/FADEOUT)")
public class TransitionAction implements Action {
	@ActionProperty(required = true, defaultValue = "1.0")
	@ActionPropertyDescription("Duration of the transition")
	private float time = 1;

	@ActionPropertyDescription("The color to fade ('white', 'black' or RRGGBBAA).")
	@ActionProperty(type = Type.COLOR, required = true, defaultValue = "black")
	private Color color = new Color(0,0,0,1);

	@ActionProperty(required = true, defaultValue = "FADE_IN")
	@ActionPropertyDescription("The transition type (fadein/fadeout)")
	private Transition.Type type = Transition.Type.FADE_IN;     // FIXME: This adds NONE as a valid value

	@ActionProperty(required = true)
	@ActionPropertyDescription("If this param is 'false' the transition is showed and the action continues inmediatly")
	private boolean wait = true;

	@Override
	public boolean run(VerbRunner cb) {
		Transition t = World.getInstance().getTransition();
		t.create(time, color, type, wait?cb:null);
		
		return wait;
	}

}