org.starhope.vergil.logic
Interface GameImplementor

All Superinterfaces:

VergilEventHandler

All Known Implementing Classes:

SmartFauxClient

public interface GameImplementor
extends VergilEventHandler

Author:

brpocock@star-hope.org

Method Summary

String	getGameCopyright() Examples:
String	getGameLicenseBrief() Examples:
String	getGameLicenseLong() Examples:
com.google.gwt.http.client.URL	getGameLicenseTextLink() Get a link to the full text of the license agreement.
String	getGameShortIdentifier() WRITEME: Document this method brpocock@star-hope.org
String	getGameSubtitle()
String	getGameTitle()
boolean	isDebug()

Methods inherited from interface org.starhope.vergil.logic.VergilEventHandler

acceptEvent

Method Detail

getGameCopyright

String getGameCopyright()

Examples:

• Copyright © 2008-2010, Res Interactive, LLC
• Copyright © 2009-2010, Bruce-Robert Pocock

Do not include the game's title, version/release information, or license terms (e.g. “All Rights Reserved”) in this string.

Returns:

A string indicating the game's copyright.

getGameLicenseBrief

String getGameLicenseBrief()

Examples:

• All Rights Reserved
• Some Rights Reserved (Creative Commons Attribution-ShareAlike 3.0)
• GNU General Public License (V3 or later)

Returns:

the game's brief licensing terms

getGameLicenseLong

String getGameLicenseLong()

Examples:

• All Rights Reserved. Reproduction in any form or any medium without express permission is prohibited and punishable by law.

• 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 3 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, see http://www.gnu.org/licenses/.

• You are free:

  • to Share — to copy, distribute and transmit the work
  • to Remix — to adapt the work

  Under the following conditions:

  • Attribution — You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).
  • Share Alike — If you alter, transform, or build upon this work, you may distribute the resulting work only under the same, similar or a compatible license.

Returns:

the game's longer licensing terms

getGameLicenseTextLink

com.google.gwt.http.client.URL getGameLicenseTextLink()

Get a link to the full text of the license agreement.

Some useful ones (for my own use):

• http://creativecommons.org/licenses/by-sa/3.0/us/
• http://www.gnu.org/licenses/gpl.html

Returns:

a URL of the full license terms

getGameShortIdentifier

String getGameShortIdentifier()

WRITEME: Document this method brpocock@star-hope.org

Returns:

WRITEME

getGameSubtitle

String getGameSubtitle()

Returns:

the subtitle or other minor text accompanying the game's title

getGameTitle

String getGameTitle()

Returns:

the game's official title

isDebug

boolean isDebug()

Returns:

true, if the game is running in a debugging mode or environment