com.bladecoder.engine.actions.LeaveAction 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

The newest version!

/*******************************************************************************
 * 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.bladecoder.engine.actions.Param.Type;
import com.bladecoder.engine.model.VerbRunner;
import com.bladecoder.engine.model.World;

@ActionDescription("Change the current scene.")
public class LeaveAction implements Action {
	@ActionPropertyDescription("The target scene")
	@ActionProperty(type = Type.SCENE, required = true)
	private String scene;

	@ActionPropertyDescription("Inits the scene and run the 'init' verb")
	@ActionProperty(defaultValue = "true", required = true)
	private boolean init = true;

	@ActionPropertyDescription("The verb to run after loading. If null, 'init' verb will be run but only if init=true")
	@ActionProperty
	private String initVerb = null;

	private World w;

	@Override
	public void init(World w) {
		this.w = w;
	}

	@Override
	public boolean run(VerbRunner cb) {
		w.setCurrentScene(scene, init, initVerb);

		return true;
	}
}