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

@ActionDescription("Play/Stop a sound")
public class SoundAction implements Action {
	@ActionPropertyDescription("The target actor")
	@ActionProperty(type = Type.INTERACTIVE_ACTOR, required = true)
	private String actor;

	@ActionPropertyDescription("The actor 'soundId' to play. If empty the current sound will be stopped.")
	@ActionProperty(type = Type.STRING)
	private String play;

	@Override
	public boolean run(VerbRunner cb) {
		
		InteractiveActor a = (InteractiveActor)World.getInstance().getCurrentScene().getActor(actor, true);
		
		if(play!= null)	a.playSound(play);
		else
			a.stopCurrentSound();
		
		return false;
	}


}